@@ -249,7 +210,7 @@ contact = """
"""
contributor_graph = """
-
+
@@ -257,3 +218,7 @@ contributor_graph = """
"""
custom_badge = """
"""
+
+slogan = ""
+
+tables = ""
diff --git a/readmeai/config/settings/prompts.toml b/readmeai/config/settings/prompts.toml
index 29c62f84..fb01c4f5 100644
--- a/readmeai/config/settings/prompts.toml
+++ b/readmeai/config/settings/prompts.toml
@@ -38,18 +38,29 @@ each response with a verb or a noun to make the summary more engaging and impact
- Do not include quotes, code snippets, or bullet points in your response. \
- Your response should be a maximum of 50 words.
"""
+logo = """
+Create a **simple, cute mascot icon** in a **minimalist style** specifically designed as a standalone iPhone app icon. The icon should have a **singular main centerpiece** that defines the entire shape of the icon, without any external borders or background.
-logo = """Design a square app logo for the software project - "{project_name}". \
-The logo should feature the project name in bold and easily readable letters. \
-The color scheme should be engaging and suitable for a technology-focused app, \
-with a white background behind the stylized app logo square with rounded corners. \
-While designing the logo, please reference the following codebase details: \n
---------------------------------------------------------------------------------
-Repository Details:
-Project Name: {project_name}
-Project Overview: {project_overview}
-Project Catch Phrase/Slogan: {project_slogan}
---------------------------------------------------------------------------------
+**Characteristics:**
+1. Use **thick, rounded outlines** to define the mascot's shape.
+2. Employ **basic geometric shapes** for facial features (e.g., dots for eyes, simple shapes for nose/mouth).
+3. Ensure a **chunky, squat body proportion** for a cute appearance.
+4. Incorporate **distinctive features** of the mascot animal/character/hero in a **simplified form**.
+5. Maintain a **friendly, approachable expression**.
+6. Fill the **square app-icon canvas** with the mascot, centered and occupying most of the space.
+7. The mascot's shape itself should form the icon boundaryโ**no additional borders or background elements**.
+8. The design should be **visually complete and balanced** without relying on a background.
+
+**Mascot Concept:**
+- Design a [insert specific animal or character relevant to your project, e.g., 'playful robot', 'curious owl', 'friendly octopus'].
+- The aesthetic should be **clean, adorable, and instantly recognizable** even at small sizes.
+
+**Project Context:**
+- **Project Name:** {project_name}
+- **Project Overview:** {project_overview}
+- **Project Slogan:** {project_slogan}
+
+The mascot should embody the spirit of your project, capturing its essence and purpose. The final design must function as a standalone icon, with the mascot's shape defining the boundaries and serving as the singular main centerpiece.
"""
overview = """Analyze the codebase, {0}, and provide a robust, yet succinct overview of the software \
@@ -76,24 +87,3 @@ Other Requirements: \n
- Your response should be a maximum of 8 words.
- The slogan should be concise and memorable.
"""
-
-mermaid = """Create a visual representation of the software project '{0}' using a flowchart diagram. \
-The diagram should clearly illustrate the main components and the flow of data or control between them, \
-representing the codebase's architecture and execution path. The output should be formatted as a Markdown code block with Mermaid syntax. \
-Below is a template for the Mermaid flowchart that you can customize based on the project's specifics: \n
---------------------------------------------------------------------------------
-
-```mermaid
-flowchart LR
-
-A[Hard] -->|Text| B(Round)
-B --> C{Decision}
-C -->|One| D[Result 1]
-C -->|Two| E[Result 2]
-```
-
---------------------------------------------------------------------------------
-While generating the diagram, please reference the following codebase details:
-File Summaries: {1}
---------------------------------------------------------------------------------
-"""
diff --git a/readmeai/config/settings/quickstart.toml b/readmeai/config/settings/quickstart.toml
new file mode 100644
index 00000000..08be6edd
--- /dev/null
+++ b/readmeai/config/settings/quickstart.toml
@@ -0,0 +1,487 @@
+[default]
+tool = "Default"
+install = "echo 'No specific installation instructions available'"
+run = "echo 'No specific run instructions available'"
+test = "echo 'No specific test instructions available'"
+shield = "https://img.shields.io/badge/Tool-Generic-lightgrey?style={badge_style}"
+website = "https://example.com"
+
+[bash]
+tool = "Bash"
+install = "./scripts/install.sh"
+run = "./scripts/run.sh"
+test = "./scripts/test.sh"
+shield = "https://img.shields.io/badge/Shell_Script-121011.svg?style={badge_style}&logo=gnu-bash&logoColor=white"
+website = "https://www.gnu.org/software/bash/"
+
+[dockerfile]
+tool = "Docker"
+install = "docker build -t {project_name} ."
+run = "docker run -it {project_name}"
+test = "docker exec -it {project_name} pytest"
+shield = "https://img.shields.io/badge/Docker-2CA5E0.svg?style={badge_style}&logo=docker&logoColor=white"
+website = "https://www.docker.com/"
+
+[docker_compose_yml]
+tool = "Docker Compose"
+install = "docker-compose build"
+run = "docker-compose up"
+test = "docker-compose run --rm {service} pytest"
+shield = "https://img.shields.io/badge/Docker_Compose-2CA5E0.svg?style={badge_style}&logo=docker&logoColor=white"
+website = "https://docs.docker.com/compose/"
+
+[docker_compose_yaml]
+tool = "Docker Compose"
+install = "docker-compose build"
+run = "docker-compose up"
+test = "docker-compose run --rm {service} pytest"
+shield = "https://img.shields.io/badge/Docker_Compose-2CA5E0.svg?style={badge_style}&logo=docker&logoColor=white"
+website = "https://docs.docker.com/compose/"
+
+[makefile]
+tool = "Make"
+install = "make install"
+run = "make run"
+test = "make test"
+shield = "https://img.shields.io/badge/GNU_Make-A8B9CC.svg?style={badge_style}&logo=gnu-make&logoColor=white"
+website = "https://www.gnu.org/software/make/"
+
+[poetry_lock]
+tool = "Poetry"
+install = "poetry install"
+run = "poetry run python {entrypoint}"
+test = "poetry run pytest"
+shield = "https://img.shields.io/badge/Poetry-3B5526.svg?style={badge_style}&logo=poetry&logoColor=white"
+website = "https://python-poetry.org/"
+
+[pipfile_lock]
+tool = "Pipenv"
+install = "pipenv install"
+run = "pipenv shell && pipenv run python {entrypoint}"
+test = "pipenv shell && pipenv run pytest"
+shield = "https://img.shields.io/badge/Pipenv-3775A9.svg?style={badge_style}&logo=pypi&logoColor=white"
+website = "https://pipenv.pypa.io/"
+
+[requirements_txt]
+tool = "Pip"
+install = "pip install -r requirements.txt"
+run = "python {entrypoint}"
+test = "pytest"
+shield = "https://img.shields.io/badge/pip-3775A9.svg?style={badge_style}&logo=pypi&logoColor=white"
+website = "https://pip.pypa.io/"
+
+[environment_yaml]
+tool = "Conda"
+install = "conda env create -f environment.yaml"
+run = "conda activate && python {entrypoint}"
+test = "conda activate && pytest"
+shield = "https://img.shields.io/badge/conda-342B029.svg?style={badge_style}&logo=anaconda&logoColor=white"
+website = "https://docs.conda.io/"
+
+[environment_yml]
+tool = "Conda"
+install = "conda env create -f environment.yaml"
+run = "conda activate && python {entrypoint}"
+test = "conda activate && pytest"
+shield = "https://img.shields.io/badge/conda-342B029.svg?style={badge_style}&logo=anaconda&logoColor=white"
+website = "https://docs.conda.io/"
+
+[pyproject_toml_flit]
+tool = "Flit"
+install = "flit install"
+run = "python -m {entrypoint}"
+test = "python -m pytest"
+shield = "https://img.shields.io/badge/Flit-3B5526.svg?style={badge_style}&logo=flit&logoColor=white"
+website = "https://flit.readthedocs.io/"
+
+[pyproject_toml_pdm]
+tool = "PDM"
+install = "pdm install"
+run = "pdm run python {entrypoint}"
+test = "pdm run pytest"
+shield = "https://img.shields.io/badge/PDM-AC75D7.svg?style={badge_style}&logo=PDM&logoColor=white"
+website = "https://pdm.fming.dev/"
+
+[package_json]
+tool = "Npm"
+install = "npm install"
+run = "npm start"
+test = "npm test"
+shield = "https://img.shields.io/badge/npm-CB3837.svg?style={badge_style}&logo=npm&logoColor=white"
+website = "https://www.npmjs.com/"
+
+[package-lock_json]
+tool = "npm"
+install = "npm ci"
+run = "npm start"
+test = "npm test"
+shield = "https://img.shields.io/badge/npm-CB3837.svg?style={badge_style}&logo=npm&logoColor=white"
+website = "https://www.npmjs.com/"
+
+[yarn_lock]
+tool = "Yarn"
+install = "yarn install"
+run = "yarn start"
+test = "yarn test"
+shield = "https://img.shields.io/badge/yarn-2C8EBB.svg?style={badge_style}&logo=yarn&logoColor=white"
+website = "https://yarnpkg.com/"
+
+[gemfile_lock]
+tool = "Bundler"
+install = "bundle install"
+run = "bundle exec ruby {entrypoint}"
+test = "bundle exec rspec"
+shield = "https://img.shields.io/badge/Ruby-CC342D.svg?style={badge_style}&logo=ruby&logoColor=white"
+website = "https://bundler.io/"
+
+[pom_xml]
+tool = "Maven"
+install = "mvn clean install"
+run = "mvn exec:java -Dexec.mainClass=\"{entrypoint}\""
+test = "mvn test"
+shield = "https://img.shields.io/badge/Apache_Maven-C71A36.svg?style={badge_style}&logo=apache-maven&logoColor=white"
+website = "https://maven.apache.org/"
+
+[maven_pom]
+tool = "Maven"
+install = "mvn install"
+run = "mvn spring-boot:run" # If it's a Spring Boot app, adjust accordingly
+test = "mvn test"
+shield = "https://img.shields.io/badge/Maven-DC5226.svg?style={badge_style}&logo=apache-maven&logoColor=white"
+website = "https://maven.apache.org/"
+
+[gradle_build]
+tool = "Gradle"
+install = "./gradlew install"
+run = "./gradlew run"
+test = "./gradlew test"
+shield = "https://img.shields.io/badge/Gradle-02303A.svg?style={badge_style}&logo=gradle&logoColor=white"
+website = "https://gradle.org/"
+
+[cargo_toml]
+tool = "Cargo"
+install = "cargo build"
+run = "cargo run"
+test = "cargo test"
+shield = "https://img.shields.io/badge/Rust-000000.svg?style={badge_style}&logo=rust&logoColor=white"
+website = "https://www.rust-lang.org/"
+
+[cargo_lock]
+tool = "Cargo"
+install = "cargo build"
+run = "cargo run"
+test = "cargo test"
+shield = "https://img.shields.io/badge/Cargo-000000.svg?style={badge_style}&logo=rust&logoColor=white"
+website = "https://doc.rust-lang.org/cargo/"
+
+[rust-toolchain_toml]
+tool = "Rust"
+install = "rustup toolchain install"
+run = "cargo run"
+test = "cargo test"
+shield = "https://img.shields.io/badge/Rust-000000.svg?style={badge_style}&logo=rust&logoColor=white"
+website = "https://www.rust-lang.org/"
+
+[go_mod]
+tool = "Go Modules"
+install = "go get ./..."
+run = "go run {entrypoint}"
+test = "go test ./..."
+shield = "https://img.shields.io/badge/Go-00ADD8.svg?style={badge_style}&logo=go&logoColor=white"
+website = "https://golang.org/"
+
+[go_sum]
+tool = "Go Modules"
+install = "go get ./..."
+run = "go run {entrypoint}"
+test = "go test ./..."
+shield = "https://img.shields.io/badge/Go-00ADD8.svg?style={badge_style}&logo=go&logoColor=white"
+website = "https://golang.org/"
+
+[gopkg_lock]
+tool = "Go Modules"
+install = "go get ./..."
+run = "go run {entrypoint}"
+test = "go test ./..."
+shield = "https://img.shields.io/badge/Go-00ADD8.svg?style={badge_style}&logo=go&logoColor=white"
+website = "https://golang.org/"
+
+[tsconfig_json]
+tool = "TypeScript"
+install = "npm install"
+run = "ts-node {entrypoint}"
+test = "npm test"
+shield = "https://img.shields.io/badge/TypeScript-007ACC.svg?style={badge_style}&logo=typescript&logoColor=white"
+website = "https://www.typescriptlang.org/"
+
+[deno_json]
+tool = "Deno"
+install = "deno cache {entrypoint}"
+run = "deno run {entrypoint}"
+test = "deno test"
+shield = "https://img.shields.io/badge/Deno-000000.svg?style={badge_style}&logo=deno&logoColor=white"
+website = "https://deno.land/"
+
+[streamlit]
+tool = "Streamlit"
+install = "pip install -r requirements.txt"
+run = "streamlit run {entrypoint}"
+test = "pytest"
+shield = "https://img.shields.io/badge/Streamlit-FF4B4B.svg?style={badge_style}&logo=streamlit&logoColor=white"
+website = "https://streamlit.io/"
+
+[sbt_build]
+tool = "sbt"
+install = "sbt compile"
+run = "sbt run"
+test = "sbt test"
+shield = "https://img.shields.io/badge/sbt-DC322F.svg?style={badge_style}&logo=scala&logoColor=white"
+website = "https://www.scala-sbt.org/"
+
+[build_sbt]
+tool = "sbt"
+install = "sbt compile"
+run = "sbt run"
+test = "sbt test"
+shield = "https://img.shields.io/badge/sbt-DC322F.svg?style={badge_style}&logo=scala&logoColor=white"
+website = "https://www.scala-sbt.org/"
+
+[mix_exs]
+tool = "Mix"
+install = "mix deps.get"
+run = "mix run"
+test = "mix test"
+shield = "https://img.shields.io/badge/Elixir-4B275F.svg?style={badge_style}&logo=elixir&logoColor=white"
+website = "https://elixir-lang.org/"
+
+[mix_lock]
+tool = "Mix"
+install = "mix deps.get"
+run = "mix run"
+test = "mix test"
+shield = "https://img.shields.io/badge/Mix-6C1F87.svg?style={badge_style}&logo=elixir&logoColor=white"
+website = "https://elixir-lang.org/getting-started/mix-otp/introduction-to-mix.html"
+
+[rebar_config]
+tool = "Rebar3"
+install = "rebar3 compile"
+run = "rebar3 shell"
+test = "rebar3 eunit"
+shield = "https://img.shields.io/badge/Erlang-A90533.svg?style={badge_style}&logo=erlang&logoColor=white"
+website = "https://www.rebar3.org/"
+
+[stack_yaml]
+tool = "Stack"
+install = "stack build"
+run = "stack exec"
+test = "stack test"
+shield = "https://img.shields.io/badge/Haskell-5D4F85.svg?style={badge_style}&logo=haskell&logoColor=white"
+website = "https://docs.haskellstack.org/"
+
+[gatsby-config_js]
+tool = "Gatsby"
+install = "npm install"
+run = "gatsby develop"
+test = "npm test"
+shield = "https://img.shields.io/badge/Gatsby-663399.svg?style={badge_style}&logo=gatsby&logoColor=white"
+website = "https://www.gatsbyjs.com/"
+
+[next_config_js]
+tool = "Next.js"
+install = "npm install"
+run = "npm run dev"
+test = "npm test"
+shield = "https://img.shields.io/badge/Next.js-000000.svg?style={badge_style}&logo=next.js&logoColor=white"
+website = "https://nextjs.org/"
+
+[nuxt_config_js]
+tool = "Nuxt.js"
+install = "npm install"
+run = "npm run dev"
+test = "npm test"
+shield = "https://img.shields.io/badge/Nuxt.js-00C58E.svg?style={badge_style}&logo=nuxt.js&logoColor=white"
+website = "https://nuxtjs.org/"
+
+[flake_nix]
+tool = "Nix"
+install = "nix-shell --run 'pip install -r requirements.txt'"
+run = "nix-shell --run 'python {entrypoint}'"
+test = "nix-shell --run 'pytest'"
+shield = "https://img.shields.io/badge/Nix-5277C3.svg?style={badge_style}&logo=nixos&logoColor=white"
+website = "https://nixos.org/"
+
+[composer_json]
+tool = "Composer"
+install = "composer install"
+run = "php {entrypoint}"
+test = "composer test"
+shield = "https://img.shields.io/badge/Composer-885630.svg?style={badge_style}&logo=composer&logoColor=white"
+website = "https://getcomposer.org/"
+
+[composer_lock]
+tool = "Composer"
+install = "composer install"
+run = "php {entrypoint}"
+test = "composer test"
+shield = "https://img.shields.io/badge/Composer-885630.svg?style={badge_style}&logo=composer&logoColor=white"
+website = "https://getcomposer.org/"
+
+[rubocop_yml]
+tool = "RuboCop"
+install = "gem install rubocop"
+run = "rubocop"
+test = "rubocop"
+shield = "https://img.shields.io/badge/RuboCop-000000.svg?style={badge_style}&logo=rubygems&logoColor=white"
+website = "https://rubocop.org/"
+
+[eslintrc_js]
+tool = "ESLint"
+install = "npm install eslint"
+run = "eslint ."
+test = "eslint ."
+shield = "https://img.shields.io/badge/ESLint-4B32C3.svg?style={badge_style}&logo=eslint&logoColor=white"
+website = "https://eslint.org/"
+
+[prettierrc_js]
+tool = "Prettier"
+install = "npm install prettier"
+run = "prettier --write ."
+test = "prettier --check ."
+shield = "https://img.shields.io/badge/Prettier-F7B93E.svg?style={badge_style}&logo=prettier&logoColor=white"
+website = "https://prettier.io/"
+
+[angular_json]
+tool = "Angular"
+install = "npm install"
+run = "ng serve"
+test = "ng test"
+shield = "https://img.shields.io/badge/Angular-0F0F11.svg?style={badge_style}&logo=Angular&logoColor=white"
+website = "https://angular.io/"
+
+[vue_config_js]
+tool = "Vue.js"
+install = "npm install"
+run = "npm run serve"
+test = "npm test"
+shield = "https://img.shields.io/badge/Vue.js-4FC08D.svg?style={badge_style}&logo=vue.js&logoColor=white"
+website = "https://vuejs.org/"
+
+[svelte_config_js]
+tool = "Svelte"
+install = "npm install"
+run = "npm run dev"
+test = "npm test"
+shield = "https://img.shields.io/badge/Svelte-FF3E00.svg?style={badge_style}&logo=Svelte&logoColor=white"
+website = "https://svelte.dev/"
+
+[pubspec_yaml]
+tool = "Flutter"
+install = "flutter pub get"
+run = "flutter run"
+test = "flutter test"
+shield = "https://img.shields.io/badge/Flutter-02569B.svg?style={badge_style}&logo=flutter&logoColor=white"
+website = "https://flutter.dev/"
+
+[project_clj]
+tool = "Leiningen"
+install = "lein deps"
+run = "lein run"
+test = "lein test"
+shield = "https://img.shields.io/badge/Leiningen-2E2E2E.svg?style={badge_style}&logo=clojure&logoColor=white"
+website = "https://leiningen.org/"
+
+[cake_build]
+tool = "Cake"
+install = "dotnet cake"
+run = "dotnet cake"
+test = "dotnet cake --target=Test"
+shield = "https://img.shields.io/badge/Cake-A41D1D.svg?style={badge_style}&logo=cakebuild&logoColor=white"
+website = "https://cakebuild.net/"
+
+[project_json]
+tool = ".NET CLI"
+install = "dotnet restore"
+run = "dotnet run --project {entrypoint}"
+test = "dotnet test"
+shield = "https://img.shields.io/badge/.NET-512BD4.svg?style={badge_style}&logo=dotnet&logoColor=white"
+website = "https://dotnet.microsoft.com/"
+
+[swift_package]
+tool = "Swift Package Manager"
+install = "swift build"
+run = "swift run"
+test = "swift test"
+shield = "https://img.shields.io/badge/Swift-F05138.svg?style={badge_style}&logo=Swift&logoColor=white"
+website = "https://swift.org/package-manager/"
+
+[xcodebuild]
+tool = "Xcode"
+install = "xcodebuild"
+run = "xcodebuild -scheme {scheme} build"
+test = "xcodebuild test"
+shield = "https://img.shields.io/badge/Xcode-147EFB.svg?style={badge_style}&logo=xcode&logoColor=white"
+website = "https://developer.apple.com/xcode/"
+
+[build_xml]
+tool = "Ant"
+install = "ant compile"
+run = "ant run"
+test = "ant test"
+shield = "https://img.shields.io/badge/Ant-A81C7D.svg?style={badge_style}&logo=apache-ant&logoColor=white"
+website = "https://ant.apache.org/"
+
+[junit_config]
+tool = "JUnit"
+install = "javac *.java"
+run = "java {entrypoint}"
+test = "java org.junit.runner.JUnitCore {entrypoint}"
+shield = "https://img.shields.io/badge/JUnit-25A162.svg?style={badge_style}&logo=junit5&logoColor=white"
+website = "https://junit.org/junit5/"
+
+[gradle_kts]
+tool = "Gradle"
+install = "./gradlew build"
+run = "./gradlew run"
+test = "./gradlew test"
+shield = "https://img.shields.io/badge/Gradle-02303A.svg?style={badge_style}&logo=gradle&logoColor=white"
+website = "https://gradle.org/"
+
+[gradle_properties]
+tool = "Gradle"
+install = "./gradlew build"
+run = "./gradlew run"
+test = "./gradlew test"
+shield = "https://img.shields.io/badge/Gradle-02303A.svg?style={badge_style}&logo=gradle&logoColor=white"
+website = "https://gradle.org/"
+
+[gradle_kotlin_dsl]
+tool = "Gradle"
+install = "./gradlew build"
+run = "./gradlew run"
+test = "./gradlew test"
+shield = "https://img.shields.io/badge/Gradle-02303A.svg?style={badge_style}&logo=gradle&logoColor=white"
+website = "https://gradle.org/"
+
+[conanfile_txt]
+tool = "Conan"
+install = "conan install ."
+run = "conan build ."
+test = "conan test ."
+shield = "https://img.shields.io/badge/Conan-3F9FFF.svg?style={badge_style}&logo=conan&logoColor=white"
+website = "https://conan.io/"
+
+[bazel]
+tool = "Bazel"
+install = "bazel build //:dependencies"
+run = "bazel run //:app"
+test = "bazel test //..."
+shield = "https://img.shields.io/badge/Bazel-66B831.svg?style={badge_style}&logo=bazel&logoColor=white"
+website = "https://bazel.build/"
+
+[meson_build]
+tool = "Meson"
+install = "meson setup builddir"
+run = "meson compile -C builddir"
+test = "meson test -C builddir"
+shield = "https://img.shields.io/badge/Meson-2E2E2E.svg?style={badge_style}&logo=meson&logoColor=white"
+website = "https://mesonbuild.com/"
diff --git a/readmeai/config/validators.py b/readmeai/config/validators.py
deleted file mode 100644
index b149b105..00000000
--- a/readmeai/config/validators.py
+++ /dev/null
@@ -1,112 +0,0 @@
-"""
-Pydantic validators for the CLI inputs and package settings.
-"""
-
-import re
-from pathlib import Path
-from typing import Optional, Union
-from urllib.parse import urlparse, urlsplit
-
-from readmeai._exceptions import GitValidationError
-from readmeai.core.logger import Logger
-from readmeai.services.git import GitHost
-
-_logger = Logger(__name__)
-
-
-class GitValidator:
- """Validator class for GitSettings."""
-
- @classmethod
- def validate_repository(cls, value: Union[str, Path]) -> Union[str, Path]:
- """Validate the repository URL or path."""
- value_str = str(value)
- if (
- any(service.value in value_str for service in GitHost) is False
- and not Path(value_str).is_dir()
- ):
- raise GitValidationError(value)
-
- if isinstance(value, str):
- path = Path(value)
- if path.is_dir():
- return value
- try:
- parsed_url = urlparse(value)
- if parsed_url.scheme in ["http", "https"] and any(
- service in parsed_url.netloc for service in GitHost
- ):
- return value
-
- except Exception as exc:
- _logger.error(f"Error validating repository: {exc}")
- raise GitValidationError(value) from exc
-
- elif isinstance(value, Path) and value.is_dir():
- return value
-
- raise GitValidationError(value)
-
- @classmethod
- def validate_full_name(cls, value: Optional[str], values: dict) -> str:
- """Validator for getting the full name of the repository."""
- url_or_path = values.get("repository")
-
- path = (
- url_or_path if isinstance(url_or_path, Path) else Path(url_or_path)
- )
- if path.exists():
- return str(path.name)
-
- patterns = {
- GitHost.GITHUB: r"https?://github.com/([^/]+)/([^/]+)",
- GitHost.GITLAB: r"https?://gitlab.com/([^/]+)/([^/]+)",
- GitHost.BITBUCKET: r"https?://bitbucket.org/([^/]+)/([^/]+)",
- }
-
- for _, pattern in patterns.items():
- match = re.match(pattern, url_or_path)
- if match:
- user_name, repo_name = match.groups()
- return f"{user_name}/{repo_name}"
-
- raise GitValidationError(url_or_path)
-
- @classmethod
- def set_host_domain(cls, value: Optional[str], values: dict) -> str:
- """Sets the Git service host from the repository provided."""
- repo = values.get("repository")
- if isinstance(repo, Path) or (
- isinstance(repo, str) and Path(repo).is_dir()
- ):
- return GitHost.LOCAL
-
- parsed_url = urlparse(str(repo))
- for service in GitHost:
- if service in parsed_url.netloc:
- return service
-
- return GitHost.LOCAL
-
- @classmethod
- def set_host(cls, value: Optional[str], values: dict) -> str:
- """Set the host based on the repository URL."""
- repo = values.get("repository")
- if isinstance(repo, Path) or (
- isinstance(repo, str) and Path(repo).is_dir()
- ):
- return GitHost.LOCAL.value.lower()
- parsed_url = urlsplit(repo)
- return parsed_url.netloc.split(".")[0]
-
- @classmethod
- def set_name(cls, value: Optional[str], values: dict) -> str:
- """Sets the repository name from the repository provided."""
- repo = values.get("repository")
- if isinstance(repo, Path):
- return repo.name
- elif isinstance(repo, str):
- parsed_url = urlsplit(repo)
- name = parsed_url.path.split("/")[-1]
- return name.removesuffix(".git")
- return "n/a"
diff --git a/readmeai/core/logger.py b/readmeai/core/logger.py
index a3375177..3d60f8c3 100644
--- a/readmeai/core/logger.py
+++ b/readmeai/core/logger.py
@@ -4,7 +4,7 @@
import logging
import sys
-from typing import Dict
+import typing
LOG_LEVEL_EMOJIS = {
"DEBUG": "โ๏ธ",
@@ -17,7 +17,6 @@
LOG_LEVEL_COLORS = {
"DEBUG": "\033[34m",
"INFO": "\033[35m",
- # "INFO": "\033[32m,
"WARNING": "\033[33m",
"ERROR": "\033[31m",
"CRITICAL": "\033[31m\033[1m",
@@ -28,7 +27,9 @@
class CustomFormatter(logging.Formatter):
- """Custom log formatter with color and emoji support."""
+ """
+ Custom logging formatter with color and emoji support.
+ """
def format(self, record) -> str:
"""Format the log record."""
@@ -39,9 +40,11 @@ def format(self, record) -> str:
class Logger:
- """Custom logger implementation."""
+ """
+ Custom logger class for the readme-ai package.
+ """
- _instances: Dict[str, "Logger"] = {}
+ _instances: typing.ClassVar[dict[str, "Logger"]] = {}
def __new__(cls, name, level="DEBUG"):
"""Creates a new logger instance."""
diff --git a/readmeai/core/models.py b/readmeai/core/models.py
index 62f11690..5710eade 100644
--- a/readmeai/core/models.py
+++ b/readmeai/core/models.py
@@ -4,13 +4,13 @@
import asyncio
from abc import ABC, abstractmethod
+from collections.abc import AsyncGenerator, Generator
from contextlib import asynccontextmanager
-from typing import Any, Dict, Generator, List, Tuple, Union
+from typing import Any
import aiohttp
-from readmeai.cli.options import ModelOptions as llms
-from readmeai.config.settings import ConfigLoader
+from readmeai.config.settings import ConfigLoader, ModelOptions
from readmeai.core.logger import Logger
from readmeai.models.prompts import (
get_prompt_context,
@@ -21,44 +21,54 @@
class BaseModelHandler(ABC):
- """Abstract base class for Large Language Model (LLM) API handlers."""
+ """
+ Abstract base class for Large Language Model (LLM) API handlers.
+ """
def __init__(self, config_loader: ConfigLoader) -> None:
- """Initializes the LLM handler with configuration and logging."""
+ """
+ Initializes the LLM handler with configuration and logging.
+ """
self._logger = Logger(__name__)
self._session: aiohttp.ClientSession = None
self.config = config_loader.config
self.prompts = config_loader.prompts
- self.sys_content = self.config.api.content
+ self.system_message = self.config.api.system_message
self.rate_limit = self.config.api.rate_limit
self.rate_limit_semaphore = asyncio.Semaphore(self.rate_limit)
@abstractmethod
- async def _model_settings(self):
- """Initializes the LLM settings for the specific API implementation."""
+ async def _model_settings(self) -> None:
+ """
+ Initializes the LLM settings for the specific API implementation.
+ """
...
@abstractmethod
- async def _build_payload(self, prompt: str, tokens: int) -> Dict[str, Any]:
- """Builds the payload for the POST request to the LLM API."""
+ async def _build_payload(self, prompt: str, tokens: int) -> dict[str, Any]:
+ """
+ Builds the payload for the POST request to the LLM API.
+ """
...
@abstractmethod
async def _make_request(
self,
- index: str,
- prompt: str,
- tokens: int,
- raw_files: List[Tuple[str, str]] = None,
- ) -> Tuple[str, str]:
- """Handles LLM API response and returns the generated text."""
+ index: str | None,
+ prompt: str | None,
+ tokens: int | None,
+ raw_files: list[tuple[str, str]] | None,
+ ) -> list[tuple[str, str]]:
+ """
+ Handles LLM API response and returns the generated text.
+ """
...
@asynccontextmanager
- async def use_api(self) -> Generator:
+ async def use_api(self) -> AsyncGenerator[Any, None]:
"""Async context manager for managing the lifecycle of the HTTP client."""
async with aiohttp.ClientSession(
- timeout=aiohttp.ClientTimeout(total=None)
+ timeout=aiohttp.ClientTimeout(total=None),
) as session:
self._session = session
try:
@@ -70,63 +80,52 @@ async def close(self) -> None:
"""Closes the HTTP client session."""
if self._session:
await self._session.close()
- self._session = None
+ self._logger.debug("HTTP client closed.")
else:
self._logger.debug("HTTP client already closed.")
async def batch_request(
self,
- dependencies: List[str],
- raw_files: List[Tuple[str, str]],
- ) -> List[str]:
- """Generates a batch of prompts and processes the responses.
-
- Parameters
- ----------
- dependencies
- List of dependencies for the project.
- raw_files
- List of tuples containing all file paths and file contents.
-
- Returns
- -------
- List of generated text responses from the LLM API.
- """
- if self.config.llm.api == llms.OFFLINE.name:
+ dependencies: list[str],
+ raw_files: list[tuple[str, str]],
+ ) -> list[tuple[str, str]]:
+ """
+ Generates a batch of prompts and processes the responses.
+ """
+ if self.config.llm.api == ModelOptions.OFFLINE.name:
return await self._make_request(
- index=None, prompt=None, tokens=None, raw_files=raw_files
+ index=None,
+ prompt=None,
+ tokens=None,
+ raw_files=raw_files,
)
else:
raw_files = [
file for file in raw_files if not file[0].endswith(".lock")
]
summaries_prompts = await set_summary_context(
- self.config, dependencies, raw_files
+ self.config,
+ dependencies,
+ raw_files,
)
summaries_responses = await self._batch_prompts(summaries_prompts)
additional_prompts = await set_additional_contexts(
- self.config, dependencies, summaries_responses
+ self.config,
+ dependencies,
+ summaries_responses,
)
additional_responses = await self._batch_prompts(additional_prompts)
return summaries_responses + additional_responses
async def _batch_prompts(
- self, prompts: List[Union[str, Tuple[str, str]]], batch_size: int = 10
- ) -> List[str]:
- """Processes a batch of prompts and returns the generated text.
-
- Parameters
- ----------
- prompts
- List of prompts to be processed.
- batch_size, optional
- Max number of prompts to process in a single batch. Defaults to 10.
-
- Returns
- -------
- List of generated text responses from the LLM API.
+ self,
+ prompts: list[str | tuple[str, str]],
+ batch_size: int = 10,
+ ) -> list[tuple[str, str]]:
+ """
+ Processes a batch of prompts and returns the generated text.
"""
responses = []
@@ -140,75 +139,64 @@ async def _batch_prompts(
return responses
def _generate_batches(
- self, items: List[Any], batch_size: int
- ) -> Generator[List[Any], None, None]:
- """Generates batches of items to be processed.
-
- Parameters
- ----------
- items
- List of items to be processed.
- batch_size
- Maximum number of items to process in a single batch.
-
- Returns
- -------
- List of batches of items to be processed.
-
- Yields
- ------
- List of items to be processed.
+ self,
+ items: list[Any],
+ batch_size: int,
+ ) -> Generator[list[Any], None, None]:
+ """
+ Generates batches of items to be processed.
"""
for i in range(0, len(items), batch_size):
yield items[i : i + batch_size]
- async def _process_batch(self, prompt: Dict[str, Any]) -> str:
- """Processes a single prompt and returns the generated text.
-
- Parameters
- ----------
- prompt
- Prompt to be processed by the LLM API.
-
- Returns
- -------
- Generated text response from the LLM API.
+ async def _process_batch(self, prompt: dict[str, Any]) -> Any:
+ """
+ Processes a single prompt and returns the generated text.
"""
if prompt["type"] == "file_summary":
return await self._make_request_code_summary(prompt["context"])
else:
formatted_prompt = get_prompt_context(
- self.prompts, prompt["type"], prompt["context"]
+ self.prompts,
+ prompt["type"],
+ prompt["context"],
+ )
+ tokens = update_max_tokens(
+ self.config.llm.tokens,
+ formatted_prompt,
)
- tokens = update_max_tokens(self.tokens, formatted_prompt)
_, summary = await self._make_request(
- prompt["type"], formatted_prompt, tokens
+ prompt["type"],
+ formatted_prompt,
+ tokens,
+ None,
)
return summary
async def _make_request_code_summary(
- self, file_context: List[Tuple[str, str]]
- ) -> List[Tuple[str, str]]:
- """Generates code summaries for each file in the project.
-
- Parameters
- ----------
- file_context
- List of tuples containing all file paths and file contents.
-
- Returns
- -------
- List of generated code summaries for each file in the project.
+ self,
+ file_context: list[tuple[str, str]],
+ ) -> list[tuple[str, str]]:
+ """
+ Generates code summaries for each file in the project.
"""
summary_text = []
for file_path, file_content in file_context["file_summary"]:
prompt = self.prompts["prompts"]["file_summary"].format(
- self.config.md.tree, file_path, file_content
+ self.config.md.tree,
+ file_path,
+ file_content,
+ )
+ tokens = update_max_tokens(
+ self.config.llm.tokens,
+ prompt,
)
- tokens = update_max_tokens(self.tokens, prompt)
_, summary_or_error = await self._make_request(
- file_path, prompt, tokens
+ file_path,
+ prompt,
+ tokens,
+ None,
)
summary_text.append((file_path, summary_or_error))
diff --git a/readmeai/core/parsers.py b/readmeai/core/parsers.py
index 74f48ba0..3e891b6f 100644
--- a/readmeai/core/parsers.py
+++ b/readmeai/core/parsers.py
@@ -1,28 +1,30 @@
-"""Abstract base class for dependency file parsers."""
+"""
+Abstract base class for dependency file parsers.
+"""
from abc import ABC, abstractmethod
-from typing import List
from readmeai.core.logger import Logger
class BaseFileParser(ABC):
- """Abstract base class for dependency file parsers."""
+ """
+ Abstract base class for dependency file parsers.
+ """
def __init__(self) -> None:
- """Initializes the handler with given configuration."""
self._logger = Logger(__name__)
@abstractmethod
- def parse(self, content: str) -> List[str]:
- """Parses content of dependency file and returns list of dependencies."""
+ def parse(self, content: str) -> list[str]:
+ """Parses content of file and return list of dependencies."""
...
def log_error(self, message: str):
"""Logs error message when parsing fails."""
self._logger.error(f"Error parsing dependency file {message}")
- def handle_parsing_error(self, error: Exception) -> List[str]:
+ def handle_parsing_error(self, error: Exception) -> list[str]:
"""Standardized error handling for parsing exceptions."""
self.log_error(str(error))
return []
diff --git a/readmeai/core/preprocess.py b/readmeai/core/preprocess.py
index f4738694..fe38a923 100644
--- a/readmeai/core/preprocess.py
+++ b/readmeai/core/preprocess.py
@@ -2,9 +2,9 @@
Pre-processes the input repository files and extracts metadata.
"""
+from collections.abc import Generator
from dataclasses import dataclass, field
from pathlib import Path
-from typing import Generator, List, Tuple
from readmeai.config.settings import ConfigLoader
from readmeai.core.logger import Logger
@@ -16,14 +16,16 @@
@dataclass
class FileContext:
- """Data class to store file contents and metadata."""
+ """
+ Data class to store file contents and metadata.
+ """
file_path: Path
file_name: str
file_ext: str
content: str
language: str = field(init=False)
- dependencies: List[str] = field(default_factory=list)
+ dependencies: list[str] = field(default_factory=list)
def __post_init__(self):
"""Initializes the FileContext class."""
@@ -40,13 +42,14 @@ def __init__(self, config_loader: ConfigLoader):
"""Initializes the RepositoryProcessor class."""
self._logger = Logger(__name__)
self.config_loader = config_loader
- self.blacklist = config_loader.blacklist.get("blacklist")
+ self.ignore_list = config_loader.ignore_list.get("ignore_list")
self.commands = config_loader.commands
self.languages = config_loader.languages.get("language_names")
self.parser_files = config_loader.parsers.get("parsers")
def create_file_data(
- self, file_info: Tuple[str, Path, str]
+ self,
+ file_info: tuple[str, Path, str],
) -> FileContext:
"""Creates a FileContext instance from the file information."""
file_name, file_path, content = file_info
@@ -57,29 +60,23 @@ def create_file_data(
file_ext="",
)
- def extract_dependencies(self, file_data: FileContext) -> List[str]:
+ def extract_dependencies(self, file_data: FileContext) -> list[str]:
"""Extracts the dependency file contents using the factory pattern."""
parsers = parser_handler()
- if file_data.file_name not in parsers:
- return []
-
parser = parsers.get(file_data.file_name)
- dependencies = parser.parse(content=file_data.content)
-
- self._logger.info(
- f"Dependency file found: {file_data.file_name}:\n{dependencies}"
- )
-
- return dependencies
+ if file_data.file_name not in parsers or parser is None:
+ return []
+ return parser.parse(content=file_data.content)
- def generate_contents(self, repo_path: str) -> List[FileContext]:
+ def generate_contents(self, repo_path: Path | str) -> list[FileContext]:
"""Generates a List of Dict of file information."""
if isinstance(repo_path, str):
repo_path = Path(repo_path)
return [file_data for file_data in self.generate_file_info(repo_path)]
def generate_file_info(
- self, repo_path: Path
+ self,
+ repo_path: Path,
) -> Generator[FileContext, None, None]:
"""
Generates FileContext instances for each file in the repository.
@@ -91,12 +88,11 @@ def generate_file_info(
if file_data:
yield file_data
- def get_dependencies(self, contents: List[FileContext]) -> List[str]:
+ def get_dependencies(self, contents: list[FileContext]) -> list[str]:
"""Returns a list of dependencies."""
try:
- dependency_dict = {}
dependencies = set()
- parser_files = self.config_loader.parsers.get("parsers")
+ parser_files = self.parser_files
for file_data in contents:
dependencies.update(file_data.dependencies)
@@ -105,48 +101,46 @@ def get_dependencies(self, contents: List[FileContext]) -> List[str]:
if file_data.file_name in parser_files["parsers"]:
dependencies.add(file_data.file_name)
- dependency_dict[
- file_data.file_name
- ] = file_data.dependencies
-
if _github_actions_path in str(file_data.file_path):
dependencies.add("github actions")
- return list(dependencies), dependency_dict
+ return list(dependencies)
except Exception as exc:
self._logger.error(f"Error getting dependencies: {exc}")
- return [], {}
+ return []
def _filter_file(self, file_path: Path) -> bool:
"""
Determines if a file should be ignored based on configurations.
"""
- blacklist = self.config_loader.blacklist["blacklist"]
is_file_ignored = any(
[
- file_path.name in blacklist["files"],
- file_path.suffix.lstrip(".") in blacklist["extensions"],
+ file_path.name in self.ignore_list["files"],
+ file_path.suffix.lstrip(".") in self.ignore_list["extensions"],
any(
- dir in file_path.parts for dir in blacklist["directories"]
+ dir in file_path.parts
+ for dir in self.ignore_list["directories"]
),
- ]
+ ],
)
if is_file_ignored and str(file_path.name) in self.parser_files:
return False
-
return not file_path.is_file() or is_file_ignored
def _language_mapper(
- self, contents: List[FileContext]
- ) -> List[FileContext]:
+ self,
+ contents: list[FileContext],
+ ) -> list[FileContext]:
"""Maps file extensions to their programming languages."""
for content in contents:
content.language = self.languages.get(content.file_ext, "").lower()
return contents
def _process_file_path(
- self, file_path: Path, repo_path: Path
+ self,
+ file_path: Path,
+ repo_path: Path,
) -> FileContext:
"""
Processes an individual file path and returns FileContext.
@@ -159,11 +153,14 @@ def _process_file_path(
file_ext="",
content="",
)
-
try:
if file_path.is_dir():
- return
-
+ return FileContext(
+ file_path=relative_path,
+ file_name=file_path.name,
+ file_ext="",
+ content="",
+ )
with file_path.open(encoding="utf-8") as file:
content = file.read()
@@ -174,35 +171,31 @@ def _process_file_path(
content=content,
)
file_data.dependencies = self.extract_dependencies(file_data)
- try:
- file_data.language = self.languages.get(
- file_data.file_ext, self.languages.get("default")
- ).lower()
- except Exception:
- file_data.language = None
-
return file_data
except (OSError, UnicodeDecodeError) as exc:
self._logger.warning(f"Error reading file {file_path}: {exc}")
+ return FileContext(
+ file_path=relative_path,
+ file_name=file_path.name,
+ file_ext="",
+ content="",
+ )
-def preprocessor(
- conf: ConfigLoader, temp_dir: str
-) -> Tuple[List[FileContext], List[str], List[Tuple[str, str]], str]:
+def preprocessor(conf: ConfigLoader, tmp_dir: str) -> tuple:
"""Processes the repository files and returns the context."""
repo_processor = RepositoryProcessor(conf)
- repo_context = repo_processor.generate_contents(temp_dir)
+ repo_context = repo_processor.generate_contents(tmp_dir)
repo_context = repo_processor._language_mapper(repo_context)
- dependencies, dependency_dict = repo_processor.get_dependencies(
- repo_context
- )
+ deps = repo_processor.get_dependencies(repo_context)
raw_files = [
(str(context.file_path), context.content) for context in repo_context
]
conf.config.md.tree = MarkdownBuilder(
- conf, dependencies, raw_files, temp_dir
+ conf,
+ deps,
+ raw_files,
+ tmp_dir,
).md_tree
- _logger = Logger(__name__)
- _logger.info(f"Dependencies: {dependency_dict}")
- return dependencies, raw_files
+ return deps, raw_files
diff --git a/readmeai/core/utils.py b/readmeai/core/utils.py
index b0d5f6b3..15a8a248 100644
--- a/readmeai/core/utils.py
+++ b/readmeai/core/utils.py
@@ -5,7 +5,7 @@
import os
from enum import Enum
-from readmeai.cli.options import ModelOptions as llms
+from readmeai.config.settings import ModelOptions as llms
from readmeai.core.logger import Logger
_logger = Logger(__name__)
@@ -16,29 +16,34 @@ class SecretKey(str, Enum):
Enum class to store the environment variable keys for the LLM API services.
"""
+ # ANTHROPIC_API_KEY = "ANTHROPIC_API_KEY"
+ GOOGLE_API_KEY = "GOOGLE_API_KEY"
OLLAMA_HOST = "OLLAMA_HOST"
OPENAI_API_KEY = "OPENAI_API_KEY"
- GOOGLE_API_KEY = "GOOGLE_API_KEY"
def _set_offline(message: str) -> tuple:
"""Set the LLM service to offline mode."""
- _logger.warning(f"{message}\n\t\t\t\tGenerating README without LLM API\n")
+ _logger.warning(
+ f"{message}\n\t\n... readme-ai engine switched to offline mode ...\n",
+ )
return llms.OFFLINE.name, llms.OFFLINE.name
def get_environment(llm_api: str = "", llm_model: str = "") -> tuple:
"""Set LLM environment variables based on the specified LLM service."""
default_models = {
- llms.OPENAI.name: "gpt-3.5-turbo",
+ # llms.ANTHROPIC.name: "claude-3-5-sonnet",
+ llms.GEMINI.name: "gemini-1.5-flash",
llms.OLLAMA.name: "mistral",
- llms.GEMINI.name: "gemini-pro",
+ llms.OPENAI.name: "gpt-3.5-turbo",
}
env_keys = {
- llms.OPENAI.name: SecretKey.OPENAI_API_KEY.value,
- llms.OLLAMA.name: SecretKey.OLLAMA_HOST.value,
+ # llms.ANTHROPIC.name: SecretKey.ANTHROPIC_API_KEY.value,
llms.GEMINI.name: SecretKey.GOOGLE_API_KEY.value,
+ llms.OLLAMA.name: SecretKey.OLLAMA_HOST.value,
+ llms.OPENAI.name: SecretKey.OPENAI_API_KEY.value,
}
if llm_api and llm_api not in env_keys:
@@ -46,7 +51,7 @@ def get_environment(llm_api: str = "", llm_model: str = "") -> tuple:
return _set_offline("\n\n\t\t\t\tOffline mode enabled by user")
_logger.warning("Invalid LLM service provided to CLI.")
return _set_offline(
- "\n\n\t\t...No LLM API settings found in environment..."
+ "\n\n\t...No LLM API settings found in environment...",
)
# If OPENAI_API_KEY does not exist in env when --api OPENAI is set
@@ -55,7 +60,7 @@ def get_environment(llm_api: str = "", llm_model: str = "") -> tuple:
and SecretKey.OPENAI_API_KEY.value not in os.environ
):
return _set_offline(
- "OPENAI_API_KEY not found in environment. Switching to offline mode."
+ "OPENAI_API_KEY not found in environment. Switching to offline mode.",
)
# If GOOGLE_API_KEY does not exist in env when --api gemini is set
@@ -64,7 +69,7 @@ def get_environment(llm_api: str = "", llm_model: str = "") -> tuple:
and SecretKey.GOOGLE_API_KEY.value not in os.environ
):
return _set_offline(
- "GOOGLE_API_KEY not found in environment. Switching to offline mode."
+ "GOOGLE_API_KEY not found in environment. Switching to offline mode.",
)
# If no specific API is provided or the provided API is valid
@@ -78,5 +83,5 @@ def get_environment(llm_api: str = "", llm_model: str = "") -> tuple:
if llm_api == llms.OFFLINE.name:
return _set_offline("Offline mode enabled by user via CLI.")
return _set_offline(
- "\n\n\t\t...No LLM API settings found in environment..."
+ "\n\n... No LLM API settings found in environment ...",
)
diff --git a/readmeai/generators/badges.py b/readmeai/generators/badges.py
index 3d454c38..ae6f16b4 100644
--- a/readmeai/generators/badges.py
+++ b/readmeai/generators/badges.py
@@ -2,16 +2,13 @@
Methods to generate and format svg badges for the README file.
"""
-from typing import Tuple
-
-from readmeai.cli.options import BadgeOptions
-from readmeai.config.settings import ConfigLoader
-from readmeai.services.git import GitHost
+from readmeai.config.settings import BadgeOptions, Settings
from readmeai.utils.file_handler import FileHandler
from readmeai.utils.file_resources import get_resource_path
+from readmeai.vcs.providers import GitHost
_package = "readmeai.generators"
-_submodule = "assets"
+_submodule = "svg"
def _format_badges(badges: list[str]) -> str:
@@ -28,20 +25,22 @@ def _format_badges(badges: list[str]) -> str:
[
f'
'
for badge in badges[i : i + badges_per_line]
- ]
+ ],
)
lines.append(
- f"{line}\n\t
" if i + badges_per_line < total else f"{line}\n"
+ f"{line}\n\t
" if i + badges_per_line < total else f"{line}\n",
)
return "\n\t".join(lines)
def build_default_badges(
- config: ConfigLoader, full_name: str, host: str
+ config: Settings,
+ full_name: str,
+ host: str,
) -> str:
"""Build metadata badges using shields.io."""
- return config.md.shields_icons.format(
+ return config.md.shieldsio_icons.format(
host=host,
full_name=full_name,
badge_color=config.md.badge_color,
@@ -50,7 +49,9 @@ def build_default_badges(
def build_project_badges(
- dependencies: list[str], icons: dict[str, str], style: str
+ dependencies: list[str],
+ icons: dict[str, str],
+ style: str,
) -> str:
"""Build HTML badges for project dependencies."""
badges = [
@@ -65,14 +66,17 @@ def build_project_badges(
return _format_badges(badges)
-def shields_icons(
- conf: ConfigLoader, dependencies: list, full_name: str, git_host: str
-) -> Tuple[str, str]:
+def shieldsio_icons(
+ conf: Settings,
+ dependencies: list,
+ full_name: str,
+ git_host: str,
+) -> tuple[str, str]:
"""
Generates badges for the README using shields.io icons.
"""
icons_path = get_resource_path(
- conf.files.shields_icons,
+ conf.files.shieldsio_icons,
_package,
_submodule,
)
@@ -81,31 +85,34 @@ def shields_icons(
default_icons = build_default_badges(conf, full_name, git_host)
project_badges = build_project_badges(
- dependencies, icons_dict, conf.md.badge_style
+ dependencies,
+ icons_dict,
+ conf.md.badge_style,
)
project_badges = conf.md.badge_icons.format(
- alignment=conf.md.alignment, badge_icons=project_badges
+ align=conf.md.align,
+ badge_icons=project_badges,
)
if (
conf.md.badge_style == BadgeOptions.DEFAULT.value
- and git_host != GitHost.LOCAL
+ and git_host != GitHost.LOCAL.name
):
return (
default_icons,
"\n",
)
- if git_host == GitHost.LOCAL:
+ if git_host == GitHost.LOCAL.name:
return (
- "\n",
+ "",
project_badges,
)
return default_icons, project_badges
-def skill_icons(conf: ConfigLoader, dependencies: list) -> str:
+def skill_icons(conf: Settings, dependencies: list) -> str:
"""
Generates badges for the README using skill icons, from the
repository - https://github.com/tandpfun/skill-icons.
@@ -113,21 +120,23 @@ def skill_icons(conf: ConfigLoader, dependencies: list) -> str:
dependencies.extend(["md"])
icons_path = get_resource_path(
- conf.files.skill_icons, _package, _submodule
+ conf.files.skill_icons,
+ _package,
+ _submodule,
)
icons_dict = FileHandler().read(icons_path)
- skill_icons = [
+ icons = [
icon for icon in icons_dict["icons"]["names"] if icon in dependencies
]
- skill_icons = ",".join(skill_icons)
- skill_icons = icons_dict["url"]["base_url"] + skill_icons
+ formatted_icons = icons_dict["url"]["base_url"] + ",".join(icons)
if conf.md.badge_style == "skills-light":
- skill_icons = f"{skill_icons}&theme=light"
+ formatted_icons = f"{formatted_icons}&theme=light"
- conf.md.skill_icons = conf.md.skill_icons.format(skill_icons)
+ conf.md.skill_icons = conf.md.skill_icons.format(formatted_icons)
return conf.md.badge_icons.format(
- alignment=conf.md.alignment, badge_icons=conf.md.skill_icons
+ align=conf.md.align,
+ badge_icons=conf.md.skill_icons,
)
diff --git a/readmeai/generators/builder.py b/readmeai/generators/builder.py
index 40826c09..7cf4a50f 100644
--- a/readmeai/generators/builder.py
+++ b/readmeai/generators/builder.py
@@ -1,15 +1,17 @@
-"""Builds each section of the README Markdown file."""
+"""
+Builds each section of the README Markdown file.
+"""
__package__ = "readmeai"
from pathlib import Path
-from typing import List
-from readmeai.cli.options import BadgeOptions
-from readmeai.config.settings import ConfigLoader
+from readmeai.config.settings import BadgeOptions, ConfigLoader
from readmeai.generators import badges, tables, tree, utils
from readmeai.generators.quickstart import get_setup_data
-from readmeai.services.git import GitHost
+from readmeai.templates.header import HeaderTemplate
+from readmeai.templates.toc import ToCTemplate
+from readmeai.vcs.providers import GitHost
class MarkdownBuilder:
@@ -18,11 +20,10 @@ class MarkdownBuilder:
def __init__(
self,
config_loader: ConfigLoader,
- dependencies: List[str],
- summaries: tuple,
+ dependencies: list[str],
+ summaries: list[tuple[str, str]],
temp_dir: str,
):
- """Initializes the MarkdownBuilder class."""
self.deps = dependencies
self.summaries = summaries
self.temp_dir = Path(temp_dir)
@@ -35,29 +36,67 @@ def __init__(
if self.git.host_domain != GitHost.LOCAL.name.lower()
else f"../{self.git.name}"
)
+ self.header_template = HeaderTemplate(self.md.header_style)
+ self.toc_template = ToCTemplate(self.md.toc_style)
@property
def md_header(self) -> str:
- """Generates the README header section."""
+ """
+ Generates the README header section.
+ """
if BadgeOptions.SKILLS.value not in self.md.badge_style:
- md_shields, md_badges = badges.shields_icons(
- self.config, self.deps, self.git.full_name, self.git.host
+ md_shields, md_badges = badges.shieldsio_icons(
+ self.config,
+ self.deps,
+ str(self.git.full_name),
+ str(self.git.host),
)
else:
md_shields = (
- ""
+ ""
)
md_badges = badges.skill_icons(self.config, self.deps)
- return self.md.header.format(
- alignment=self.md.alignment,
- image=self.md.image,
- width=self.md.width,
- repo_name=self.git.name.upper(),
- slogan=self.md.slogan,
- shields_icons=md_shields,
- badge_icons=md_badges,
- )
+ header_data = {
+ "align": self.md.align,
+ "image": self.md.image,
+ "image_width": self.md.image_width,
+ "repo_name": self.git.name.upper()
+ if self.git.name
+ else self.md.placeholder,
+ "slogan": self.md.slogan,
+ "shields_icons": md_shields,
+ "badge_icons": md_badges,
+ }
+ return self.header_template.render(header_data)
+
+ @property
+ def md_toc(self) -> str:
+ """
+ Generates the README Table of Contents section.
+ """
+ toc_data = {
+ "sections": [
+ {"title": "๐ Overview"},
+ {"title": "๐พ Features"},
+ {"title": "๐ Repository Structure"},
+ {"title": "๐งฉ Modules"},
+ {
+ "title": "๐ Getting Started",
+ "subsections": [
+ {"title": "๐ Prerequisites"},
+ {"title": "๐ฆ Installation"},
+ {"title": "๐ค Usage"},
+ {"title": "๐งช Tests"},
+ ],
+ },
+ {"title": "๐ Project Roadmap"},
+ {"title": "๐ค Contributing"},
+ {"title": "๐ License"},
+ {"title": "๐ Acknowledgments"},
+ ],
+ }
+ return self.toc_template.render(toc_data)
@property
def md_summaries(self) -> str:
@@ -92,10 +131,10 @@ def md_quickstart(self) -> str:
return self.md.quickstart.format(
repo_name=self.git.name,
repo_url=self.repo_url,
+ prerequisites=setup_data.prerequisites,
install_command=setup_data.install_command,
run_command=setup_data.run_command,
test_command=setup_data.test_command,
- system_requirements=setup_data.prerequisites,
)
@property
@@ -110,10 +149,12 @@ def md_contributing(self) -> str:
)
def build(self) -> str:
- """Builds the README Markdown file."""
+ """
+ Builds each section of the README.md file.
+ """
md_contents = [
self.md_header,
- self.md.toc.format(repo_name=self.git.name),
+ self.md_toc,
self.md.overview,
self.md.features,
self.md_tree,
diff --git a/readmeai/generators/quickstart.py b/readmeai/generators/quickstart.py
index 5f383b1f..abee0ed2 100644
--- a/readmeai/generators/quickstart.py
+++ b/readmeai/generators/quickstart.py
@@ -1,9 +1,10 @@
-"""Dynamically creates the 'Quickstart' section of the README file."""
+"""
+Dynamically generate 'Quickstart' guides for the README file.
+"""
import traceback
from dataclasses import dataclass
from pathlib import Path
-from typing import Dict, List
from readmeai.config.settings import ConfigLoader
from readmeai.core.logger import Logger
@@ -13,60 +14,65 @@
@dataclass
class QuickStart:
- """Information about using, running, and testing a repository."""
+ """
+ Information about using, running, and testing a repository.
+ """
install_command: str
run_command: str
test_command: str
prerequisites: str
- language_counts: Dict[str, int]
- language_key: str
- language_name: str = None
+ language_counts: dict[str, int]
+ language_key: str | None
+ language_name: str | None = None
def count_languages(
- summaries: List[str], config_loader: ConfigLoader
-) -> Dict[str, int]:
+ summaries: tuple,
+ config_loader: ConfigLoader,
+) -> dict[str, int]:
"""
Counts the occurrences of each language in the summaries.
"""
parser_files = config_loader.parsers.get("parsers")
- language_counts = {}
+ language_counts: dict[str, int] = {}
for file_path, _ in summaries:
- language = Path(file_path).suffix[1:]
+ language = Path(file_path).suffix[1:] or None
if str(file_path) in [
dependency_file for dependency_file in parser_files
]:
continue
- if language and language not in config_loader.blacklist:
+ if (
+ language
+ and language.strip()
+ and language not in config_loader.ignore_list
+ ):
language_counts[language] = language_counts.get(language, 0) + 1
return language_counts
-def get_top_language(language_counts: Dict[str, int]) -> str:
+def get_top_language(language_counts: dict[str, int]) -> str | None:
"""
Determines the top language.
"""
if not language_counts:
return None
-
- return max(sorted(language_counts), key=language_counts.get)
+ else:
+ return max(sorted(language_counts), key=language_counts.get)
def get_top_language_setup(
- language_counts: Dict[str, int], config_loader: ConfigLoader
+ language_counts: dict,
+ config_loader: ConfigLoader,
) -> QuickStart:
"""
Determines the top language and retrieves its setup commands.
"""
- if not language_counts:
- return None
-
languages = config_loader.languages.get("language_names")
commands = config_loader.commands.get("quickstart_guide")
@@ -77,15 +83,16 @@ def get_top_language_setup(
return QuickStart(
*quickstart_commands,
- prerequisites,
- language_counts,
- language_key,
- language_name,
+ prerequisites=prerequisites,
+ language_counts=language_counts,
+ language_key=language_key,
+ language_name=language_name,
)
def get_setup_data(
- config_loader: ConfigLoader, summaries: List[str]
+ config_loader: ConfigLoader,
+ summaries: tuple,
) -> QuickStart:
"""
Generates the 'Quick Start' section of the README file.
diff --git a/readmeai/generators/assets/icons.json b/readmeai/generators/svg/shieldsio_icons.json
similarity index 100%
rename from readmeai/generators/assets/icons.json
rename to readmeai/generators/svg/shieldsio_icons.json
diff --git a/readmeai/generators/assets/skill_icons.json b/readmeai/generators/svg/skill_icons.json
similarity index 100%
rename from readmeai/generators/assets/skill_icons.json
rename to readmeai/generators/svg/skill_icons.json
diff --git a/readmeai/generators/tables.py b/readmeai/generators/tables.py
index ddba82d7..138b1bda 100644
--- a/readmeai/generators/tables.py
+++ b/readmeai/generators/tables.py
@@ -1,37 +1,101 @@
-"""Creates markdown tables to store LLM text responses in the README file."""
+"""
+Creates Markdown tables to store LLM text responses in the README file.
+"""
from pathlib import Path
-from typing import List, Tuple
-from readmeai.services.git import fetch_git_file_url
+from readmeai.core.logger import Logger
+from readmeai.vcs.url_builder import GitURL
+
+_logger = Logger(__name__)
def construct_markdown_table(
- data: List[Tuple[str, str]], repo_url: str, full_name: str
+ data: list[tuple[str, str]],
+ repo_path: str | Path,
+ full_name: str,
+ max_rows: int = 100,
) -> str:
- """Builds a Markdown table from the provided data."""
+ """
+ Builds a Markdown table to store LLM text responses in README file.
+ """
+ assert isinstance(data, list), "Data must be a list"
+ assert all(
+ isinstance(item, tuple) and len(item) == 2 for item in data
+ ), "Each data item must be a tuple of (str, str)"
+ assert isinstance(
+ repo_path,
+ str | Path,
+ ), "repo_path must be a string or Path"
+ assert isinstance(full_name, str), "full_name must be a string"
+ assert (
+ isinstance(max_rows, int) and max_rows > 0
+ ), "max_rows must be a positive integer"
+
+ if not data:
+ _logger.warning("Empty data provided for Markdown table")
+ return ""
+
+ is_local_repo = Path(repo_path).exists()
+
+ if not is_local_repo:
+ try:
+ git_url = GitURL.create(str(repo_path))
+ except ValueError:
+ _logger.error(f"Invalid Git repository URL: {repo_path}")
+ is_local_repo = True # Fallback to treating it as a local path
+
headers = ["File", "Summary"]
table_rows = [headers, ["---", "---"]]
- for module, summary in data:
- file_name = str(Path(module).name)
- if "invalid" in full_name.lower():
- return file_name
- host_url = fetch_git_file_url(module, full_name, repo_url)
- md_format_host_url = f"[{file_name}]({host_url})"
- table_rows.append([md_format_host_url, summary])
+ for module, summary in data[:max_rows]:
+ file_name = Path(module).name
+ if is_local_repo:
+ file_path = Path(repo_path) / module
+ md_format_file_url = f"[{file_name}]({file_path})"
+ else:
+ try:
+ file_url = git_url.get_file_url(module)
+ md_format_file_url = f"[{file_name}]({file_url})"
+ except ValueError as e:
+ _logger.error(f"Error generating file URL for {module}: {e}")
+ md_format_file_url = file_name
+
+ table_rows.append([md_format_file_url, summary])
+
+ if len(data) > max_rows:
+ _logger.warning(
+ f"Table truncated. Showing {max_rows} out of {len(data)} rows.",
+ )
+ table_rows.append(["...", "..."])
+
+ return _format_as_markdown_table(table_rows)
+
+
+def _format_as_markdown_table(rows: list[list[str]]) -> str:
+ """
+ Formats the given rows as a Markdown table.
+ """
+ assert len(rows) >= 3, "Table must have at least headers and separator"
+ assert all(
+ len(row) == len(rows[0]) for row in rows
+ ), "All rows must have the same number of columns"
- return format_as_markdown_table(table_rows)
+ return "\n".join(f"| {' | '.join(row)} |" for row in rows)
def extract_folder_name(module: str) -> str:
- """Extracts the folder name from a module path."""
+ """
+ Extracts the folder name from a module path.
+ """
path_parts = Path(module).parts
return ".".join(path_parts[:-1]) if len(path_parts) > 1 else "."
-def format_as_markdown_table(rows: List[List[str]]) -> str:
- """Formats rows of data as a Markdown table."""
+def format_as_markdown_table(rows: list[list[str]]) -> str:
+ """
+ Formats rows of data as a Markdown table.
+ """
max_column_widths = [
max(len(str(row[col])) for row in rows) for col in range(len(rows[0]))
]
@@ -40,7 +104,7 @@ def format_as_markdown_table(rows: List[List[str]]) -> str:
"| "
+ " | ".join(
str(item).ljust(width)
- for item, width in zip(row, max_column_widths)
+ for item, width in zip(row, max_column_widths, strict=False)
)
+ " |"
for row in rows
@@ -50,9 +114,12 @@ def format_as_markdown_table(rows: List[List[str]]) -> str:
def format_code_summaries(
- placeholder: str, code_summaries: Tuple[str, str]
-) -> List[Tuple[str, str]]:
- """Converts the given code summaries into a formatted list."""
+ placeholder: str,
+ code_summaries: list[tuple[str, str]],
+) -> list[tuple[str, str]]:
+ """
+ Converts the given code summaries into a formatted list.
+ """
formatted_summaries = []
for summary in code_summaries:
@@ -68,17 +135,21 @@ def format_code_summaries(
def generate_markdown_tables(
table_widget: str,
- summaries: List[Tuple[str, str]],
+ summaries: list[tuple[str, str]],
project_name: str,
repository_url: str,
) -> str:
- """Produces Markdown tables for each project sub-directory."""
+ """
+ Produces Markdown tables for each project sub-directory.
+ """
summaries_by_folder = group_summaries_by_folder(summaries)
markdown_tables = []
for folder, entries in summaries_by_folder.items():
table_in_markdown = construct_markdown_table(
- entries, repository_url, project_name
+ entries,
+ repository_url,
+ project_name,
)
table_wrapper = table_widget.format(folder, table_in_markdown)
markdown_tables.append(table_wrapper)
@@ -86,15 +157,19 @@ def generate_markdown_tables(
return "\n".join(markdown_tables)
-def group_summaries_by_folder(summaries: List[Tuple[str, str]]) -> dict:
- """Groups code summaries by their sub-directory."""
- folder_map = {}
+def group_summaries_by_folder(summaries: list[tuple[str, str]]) -> dict:
+ """
+ Groups code summaries by their sub-directory.
+ """
+ folder_map: dict[str, list[tuple[str, str]]] = {}
for module, summary in summaries:
folder_name = extract_folder_name(module)
folder_map.setdefault(folder_name, []).append((module, summary))
return folder_map
-def is_valid_tuple_summary(summary: Tuple[str, str]) -> bool:
- """Checks if a summary is a valid tuple format."""
+def is_valid_tuple_summary(summary: tuple[str, str]) -> bool:
+ """
+ Checks if a summary is a valid tuple format.
+ """
return isinstance(summary, tuple) and len(summary) == 2
diff --git a/readmeai/generators/tree.py b/readmeai/generators/tree.py
index 9f25f2bf..568991b8 100644
--- a/readmeai/generators/tree.py
+++ b/readmeai/generators/tree.py
@@ -1,13 +1,21 @@
-"""Generates a directory tree structure for a code repository."""
+"""
+Generates a directory tree structure for a code repository.
+"""
from pathlib import Path
class TreeGenerator:
- """Generates a directory tree structure for a code repository."""
+ """
+ Generates a directory tree structure for a code repository.
+ """
def __init__(
- self, repo_name: str, root_dir: Path, repo_url: Path, max_depth: int
+ self,
+ repo_name: str,
+ root_dir: Path,
+ repo_url: Path,
+ max_depth: int,
):
self.repo_name = repo_name
self.root_dir = root_dir
@@ -21,7 +29,9 @@ def _build_tree(
is_last: bool = True,
depth: int = 0,
) -> str:
- """Generates a tree structure for a given directory."""
+ """
+ Generates a tree structure for a given directory.
+ """
if depth > self.max_depth:
return ""
@@ -42,7 +52,10 @@ def _build_tree(
for index, child in enumerate(children):
child_prefix = prefix + (" " if is_last else "โ ")
child_tree = self._build_tree(
- child, child_prefix, index == len(children) - 1, depth + 1
+ child,
+ child_prefix,
+ index == len(children) - 1,
+ depth + 1,
)
if child_tree:
@@ -51,9 +64,12 @@ def _build_tree(
return "\n".join(parts)
def tree(self) -> str:
- """Generates and formats a tree structure."""
+ """
+ Generates and formats a tree structure.
+ """
md_tree = self._build_tree(self.root_dir)
formatted_md_tree = md_tree.replace(
- self.root_dir.name, f"{self.repo_name}/"
+ self.root_dir.name,
+ f"{self.repo_name}/",
)
return formatted_md_tree
diff --git a/readmeai/generators/utils.py b/readmeai/generators/utils.py
index 205f64df..a6c56812 100644
--- a/readmeai/generators/utils.py
+++ b/readmeai/generators/utils.py
@@ -1,7 +1,8 @@
-"""Utilities to remove default emojis from markdown content."""
+"""
+Utilities to remove default emojis from markdown content.
+"""
import re
-from typing import List
EMOJI_PATTERN = re.compile(
pattern="["
@@ -21,8 +22,10 @@
)
-def remove_emojis(md_content: List[str]) -> List[str]:
- """Removes emojis from the content list."""
+def remove_emojis(md_content: list[str]) -> list[str]:
+ """
+ Removes emojis from the content list.
+ """
modified_content = []
for section in md_content:
@@ -44,7 +47,8 @@ def split_markdown_headings(markdown_text: str) -> dict:
Splits a markdown document by level 2 headings into separate sections.
"""
sections = re.split(r"(?m)^## ", markdown_text)
- split_sections = {}
+
+ split_sections: dict[str, str] = {}
for section in sections:
if section.strip():
diff --git a/readmeai/models/dalle.py b/readmeai/models/dalle.py
index e4ab67ea..16d8a475 100644
--- a/readmeai/models/dalle.py
+++ b/readmeai/models/dalle.py
@@ -1,8 +1,10 @@
"""
-Multi-modal model for generating images using OpenAI's DALL-E model.
+Handler for generating images using OpenAI's DALL-E model.
"""
import os
+from collections.abc import Generator
+from contextlib import contextmanager
from openai import Client, OpenAIError
from requests import get
@@ -13,22 +15,33 @@
class DalleHandler:
- """Generates and downloads images using OpenAI's DALL-E model."""
+ """
+ Generates and downloads images using OpenAI's DALL-E model.
+ """
- def __init__(self, config: ConfigLoader) -> None:
+ def __init__(self, conf: ConfigLoader) -> None:
"""Initialize the ImageGenerator class."""
- self.client = Client(api_key=os.getenv("OPENAI_API_KEY"))
- self.conf = config
+ self.conf = conf
+ self.filename = f"{conf.config.git.name}.png"
self._logger = Logger(__name__)
self._model_settings()
def _model_settings(self) -> None:
"""Initializes the DALL-E settings."""
+ self.client = Client(api_key=os.getenv("OPENAI_API_KEY"))
self.model = "dall-e-3"
self.size = "1792x1024"
self.quality = "standard"
self.n = 1
+ @contextmanager
+ def use_api(self) -> Generator:
+ """Yields the DALL-E handler."""
+ try:
+ yield self
+ finally:
+ self._logger.debug(f"Closed {self.model.upper()} API session.")
+
def _build_payload(self) -> str:
"""Formats the prompt string using configuration data."""
return {
@@ -43,7 +56,7 @@ def _build_payload(self) -> str:
"n": self.n,
}
- def run(self) -> str:
+ def _make_request(self) -> str:
"""Generates an image and returns its URL."""
try:
payload = self._build_payload()
@@ -52,31 +65,31 @@ def run(self) -> str:
return response.data[0].url
else:
self._logger.error(
- f"Failed to generate {self.model.upper()} image: {response}"
+ f"Failed to generate {self.model.upper()} image: {response}",
)
return ImageOptions.BLUE.value
except (Exception, OpenAIError) as exc:
self._logger.error(
- f"{self.model.upper()} image generation error: {exc}"
+ f"{self.model.upper()} image generation error: {exc}",
)
return ImageOptions.BLUE.value
def download(self, image_url) -> str:
"""Downloads an image from the given URL."""
- filename = f"{self.conf.config.git.name}.png"
try:
response = get(image_url)
- if response.status_code == 200:
- with open(filename, "wb") as f:
+ status_code = response.status_code
+
+ if status_code == 200:
+ with open(self.filename, "wb") as f:
f.write(response.content)
- return filename
+ self._logger.info(f"Image downloaded at: {image_url}")
+ return self.filename
else:
- self._logger.error(
- f"Failed to download image: {response.status_code}"
- )
- return ImageOptions.BLUE.value
+ self._logger.error(f"Failed to download image: {status_code}")
except Exception as exc:
self._logger.error(f"Failed to download image: {exc}")
- return ImageOptions.BLUE.value
+
+ return ImageOptions.BLUE.value
diff --git a/readmeai/models/factory.py b/readmeai/models/factory.py
index 889d8425..f94c9e53 100644
--- a/readmeai/models/factory.py
+++ b/readmeai/models/factory.py
@@ -1,32 +1,38 @@
"""
-Model factory that returns the appropriate LLM handler based on CLI input.
+Factory class that selects appropriate LLM API service based on CLI input.
"""
+from typing import ClassVar
+
from readmeai._exceptions import UnsupportedServiceError
-from readmeai.cli.options import ModelOptions as llms
-from readmeai.config.settings import ConfigLoader
+from readmeai.config.settings import ConfigLoader, ModelOptions
from readmeai.core.models import BaseModelHandler
from readmeai.models.gemini import GeminiHandler
from readmeai.models.offline import OfflineHandler
from readmeai.models.openai import OpenAIHandler
-class ModelFactory:
- """Factory that returns the appropriate LLM handler based on CLI input."""
+class ModelRegistry:
+ """
+ Returns the appropriate LLM API handler based on CLI input.
+ """
- _model_map = {
- llms.OFFLINE.value: OfflineHandler,
- llms.OLLAMA.value: OpenAIHandler,
- llms.OPENAI.value: OpenAIHandler,
- llms.GEMINI.value: GeminiHandler,
+ _model_map: ClassVar[dict] = {
+ # ModelOptions.ANTHROPIC.value: AnthropicHandler,
+ ModelOptions.GEMINI.value: GeminiHandler,
+ ModelOptions.OFFLINE.value: OfflineHandler,
+ ModelOptions.OLLAMA.value: OpenAIHandler,
+ ModelOptions.OPENAI.value: OpenAIHandler,
}
@staticmethod
- def model_handler(conf: ConfigLoader) -> BaseModelHandler:
- """Returns the appropriate LLM API handler based on CLI input."""
- llm_handler = ModelFactory._model_map.get(conf.config.llm.api)
- if llm_handler is None:
+ def get_backend(conf: ConfigLoader) -> BaseModelHandler:
+ """
+ Returns the appropriate LLM API handler based on CLI input.
+ """
+ backend_service = ModelRegistry._model_map.get(conf.config.llm.api)
+ if backend_service is None:
raise UnsupportedServiceError(
- f"Unsupported LLM service provided: {conf.config.llm.api}"
+ f"Unsupported LLM service provided: {conf.config.llm.api}",
)
- return llm_handler(conf)
+ return backend_service(conf)
diff --git a/readmeai/models/gemini.py b/readmeai/models/gemini.py
index 4265f87a..40889bb2 100644
--- a/readmeai/models/gemini.py
+++ b/readmeai/models/gemini.py
@@ -3,7 +3,6 @@
"""
import os
-from typing import List, Tuple
import aiohttp
import google.generativeai as genai
@@ -15,6 +14,7 @@
)
from readmeai.config.settings import ConfigLoader
+from readmeai.core.logger import Logger
from readmeai.core.models import BaseModelHandler
from readmeai.models.tokens import token_handler
from readmeai.utils.text_cleaner import clean_response
@@ -26,11 +26,13 @@ class GeminiHandler(BaseModelHandler):
def __init__(self, config_loader: ConfigLoader) -> None:
"""Initializes the Gemini API handler."""
super().__init__(config_loader)
+ self._logger = Logger(__name__)
self._model_settings()
def _model_settings(self):
"""Initializes the Gemini API LLM settings."""
- genai.configure(api_key=os.getenv("GOOGLE_API_KEY"))
+ api_key = os.getenv("GOOGLE_API_KEY")
+ genai.configure(api_key=api_key)
self.model = genai.GenerativeModel(self.config.llm.model)
self.temperature = self.config.llm.temperature
self.tokens = self.config.llm.tokens
@@ -39,10 +41,9 @@ def _model_settings(self):
async def _build_payload(self, prompt: str, tokens: int) -> dict:
"""Build payload for POST request to the Gemini API."""
return genai.types.GenerationConfig(
- # candidate_count=1,
- # stop_sequences=['x'],
max_output_tokens=self.tokens,
temperature=self.temperature,
+ top_p=self.top_p,
)
@retry(
@@ -53,19 +54,22 @@ async def _build_payload(self, prompt: str, tokens: int) -> dict:
aiohttp.ClientError,
aiohttp.ClientResponseError,
aiohttp.ClientConnectorError,
- )
+ ),
),
)
async def _make_request(
self,
- index: str,
- prompt: str,
- tokens: int,
- raw_files: List[Tuple[str, str]] = None,
- ) -> Tuple[str, str]:
- """Processes Gemini API responses and returns generated text."""
+ index: str | None,
+ prompt: str | None,
+ tokens: int | None,
+ raw_files: list[tuple[str, str]] | None,
+ ) -> list[tuple[str, str]]:
+ """
+ Processes Gemini API responses and returns generated text.
+ """
try:
prompt = await token_handler(self.config, index, prompt, tokens)
+
parameters = await self._build_payload(prompt, tokens)
async with self.rate_limit_semaphore:
@@ -74,15 +78,18 @@ async def _make_request(
generation_config=parameters,
)
response_text = response.text
+
self._logger.info(f"Response for '{index}':\n{response_text}")
+
return index, clean_response(index, response_text)
except (
aiohttp.ClientError,
aiohttp.ClientResponseError,
aiohttp.ClientConnectorError,
- ) as exc:
+ ):
self._logger.error(
- f"Error making request to Gemini API for `{index}`: {exc}"
+ f"Error processing request for prompt: {index}",
+ exc_info=True,
)
return index, self.config.md.placeholder
diff --git a/readmeai/models/offline.py b/readmeai/models/offline.py
index bf825edc..0e2af92f 100644
--- a/readmeai/models/offline.py
+++ b/readmeai/models/offline.py
@@ -2,7 +2,7 @@
Model handler for running the CLI without a LLM API service.
"""
-from typing import Any, Dict, List, Tuple
+from typing import Any
from readmeai.config.settings import ConfigLoader
from readmeai.core.models import BaseModelHandler
@@ -18,20 +18,22 @@ def __init__(self, config_loader: ConfigLoader) -> None:
def _model_settings(self):
"""Set default values for offline mode."""
- self.placeholder = self.config.md.placeholder
+ self.placeholder: str = self.config.md.placeholder
- async def _build_payload(self, prompt: str, tokens: int) -> Dict[str, Any]:
+ async def _build_payload(self, prompt: str, tokens: int) -> dict[str, Any]:
"""Builds the payload for the POST request to the LLM API."""
- ...
+ return {}
async def _make_request(
self,
- index: str = None,
- prompt: str = None,
- tokens: int = None,
- raw_files: List[Tuple[str, str]] = None,
- ) -> Tuple[str, str]:
- """Returns placeholder text where LLM API response would be."""
+ index: str | None,
+ prompt: str | None,
+ tokens: int | None,
+ raw_files: list[tuple[str, str]] | None,
+ ) -> list[tuple[str, str]]:
+ """
+ Returns placeholder text where LLM API response would be.
+ """
file_summaries = [
(str(file_path), self.placeholder) for file_path, _ in raw_files
]
diff --git a/readmeai/models/openai.py b/readmeai/models/openai.py
index eed26007..ca4a5e2f 100644
--- a/readmeai/models/openai.py
+++ b/readmeai/models/openai.py
@@ -3,7 +3,6 @@
"""
import os
-from typing import List, Tuple
import aiohttp
import openai
@@ -14,17 +13,16 @@
wait_exponential,
)
-from readmeai.cli.options import ModelOptions as llms
-from readmeai.config.settings import ConfigLoader
+from readmeai.config.settings import ConfigLoader, ModelOptions
from readmeai.core.models import BaseModelHandler
from readmeai.models.tokens import token_handler
from readmeai.utils.text_cleaner import clean_response
-_localhost = "http://localhost:11434/v1/"
-
class OpenAIHandler(BaseModelHandler):
- """OpenAI API LLM implementation."""
+ """
+ OpenAI API LLM implementation, with Ollama support.
+ """
def __init__(self, config_loader: ConfigLoader) -> None:
"""Initialize OpenAI API LLM handler."""
@@ -32,22 +30,26 @@ def __init__(self, config_loader: ConfigLoader) -> None:
self._model_settings()
def _model_settings(self):
- """Set default values for OpenAI API."""
+ """Setup configuration for OpenAI/OLLAMA LLM handlers."""
+ self.host_name = self.config.llm.host_name
+ self.localhost = self.config.llm.localhost
self.model = self.config.llm.model
+ self.path = self.config.llm.path
self.temperature = self.config.llm.temperature
self.tokens = self.config.llm.tokens
self.top_p = self.config.llm.top_p
- if self.config.llm.api == llms.OPENAI.name:
- self.endpoint = self.config.llm.base_url
- self.client = openai.OpenAI(
- api_key=os.environ.get("OPENAI_API_KEY")
- )
- elif self.config.llm.api == llms.OLLAMA.name:
- self.endpoint = f"{_localhost}chat/completions"
+ if self.config.llm.api == ModelOptions.OPENAI.name:
+ self.url = f"{self.host_name}{self.path}"
+ self.client = openai.OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
+
+ elif self.config.llm.api == ModelOptions.OLLAMA.name:
+ self.url = f"{self.localhost}{self.path}"
self.client = openai.OpenAI(
- base_url=_localhost, api_key=llms.OLLAMA.name
+ base_url=f"{self.localhost}v1",
+ api_key=ModelOptions.OLLAMA.name,
)
+
self.headers = {"Authorization": f"Bearer {self.client.api_key}"}
async def _build_payload(self, prompt: str, tokens: int) -> dict:
@@ -56,7 +58,7 @@ async def _build_payload(self, prompt: str, tokens: int) -> dict:
"messages": [
{
"role": "system",
- "content": self.sys_content,
+ "content": self.system_message,
},
{"role": "user", "content": prompt},
],
@@ -74,31 +76,32 @@ async def _build_payload(self, prompt: str, tokens: int) -> dict:
aiohttp.ClientResponseError,
aiohttp.ClientConnectorError,
openai.OpenAIError,
- )
+ ),
),
)
async def _make_request(
self,
- index: str,
- prompt: str,
- tokens: int,
- raw_files: List[Tuple[str, str]] = None,
- ) -> Tuple[str, str]:
+ index: str | None,
+ prompt: str | None,
+ tokens: int | None,
+ raw_files: list[tuple[str, str]] | None,
+ ) -> list[tuple[str, str]]:
"""Processes OpenAI API LLM responses and returns generated text."""
try:
prompt = await token_handler(self.config, index, prompt, tokens)
+
parameters = await self._build_payload(prompt, tokens)
async with self._session.post(
- self.endpoint,
+ self.url,
headers=self.headers,
json=parameters,
) as response:
response.raise_for_status()
- response = await response.json()
- text = response["choices"][0]["message"]["content"]
- self._logger.info(f"Response for '{index}':\n{text}")
- return index, clean_response(index, text)
+ data = await response.json()
+ data = data["choices"][0]["message"]["content"]
+ self._logger.info(f"Generated text for '{index}': {data}")
+ return index, clean_response(index, data)
except (
aiohttp.ClientError,
@@ -106,6 +109,5 @@ async def _make_request(
aiohttp.ClientConnectorError,
openai.OpenAIError,
) as exc:
- message = f"Error making request for - `{index}`: {exc}"
- self._logger.error(message)
+ self._logger.error(f"Error making request for '{index}': {exc}")
return index, self.config.md.placeholder
diff --git a/readmeai/models/prompts.py b/readmeai/models/prompts.py
index a8468a32..0ff3d9ac 100644
--- a/readmeai/models/prompts.py
+++ b/readmeai/models/prompts.py
@@ -2,18 +2,17 @@
Methods for processing prompts used in LLM API requests.
"""
-from typing import Dict, List, Union
-
-import readmeai.config.settings as Settings
+from readmeai.config.settings import Settings
from readmeai.core.logger import Logger
_logger = Logger(__name__)
def get_prompt_context(prompts: dict, prompt_type: str, context: dict) -> str:
- """Generates a prompt for the LLM API."""
+ """
+ Generates a prompt for the LLM API.
+ """
prompt_template = get_prompt_template(prompts, prompt_type)
-
if not prompt_template:
_logger.error(f"Prompt type '{prompt_type}' not found.")
return ""
@@ -22,7 +21,9 @@ def get_prompt_context(prompts: dict, prompt_type: str, context: dict) -> str:
def get_prompt_template(prompts: dict, prompt_type: str) -> str:
- """Retrieves the template for the given prompt type."""
+ """
+ Retrieves the template for the given prompt type.
+ """
prompt_templates = {
"features": prompts["prompts"]["features"],
"overview": prompts["prompts"]["overview"],
@@ -32,7 +33,9 @@ def get_prompt_template(prompts: dict, prompt_type: str) -> str:
def inject_prompt_context(template: str, context: dict) -> str:
- """Formats the template with the provided context."""
+ """
+ Formats the template with the provided context.
+ """
try:
return template.format(*[context[key] for key in context])
except KeyError as exc:
@@ -42,10 +45,12 @@ def inject_prompt_context(template: str, context: dict) -> str:
async def set_additional_contexts(
config: Settings,
- dependencies: List[str],
- file_summaries: List[str],
-) -> List[dict]:
- """Generates additional prompts (features, overview, slogan) for LLM."""
+ dependencies: list[str],
+ file_summaries: list[tuple[str, str]],
+) -> list[dict]:
+ """
+ Generates additional prompts (features, overview, slogan) for LLM.
+ """
return [
{"type": prompt_type, "context": context}
for prompt_type, context in [
@@ -78,10 +83,12 @@ async def set_additional_contexts(
async def set_summary_context(
config: Settings,
- dependencies: List[str],
- file_summaries: List[str],
-) -> List[Dict[str, Union[str, dict]]]:
- """Generates the summary prompts to be used by the LLM API."""
+ dependencies: list[str],
+ file_summaries: list[str],
+) -> list[dict]:
+ """
+ Generates the summary prompts to be used by the LLM API.
+ """
return [
{"type": prompt_type, "context": context}
for prompt_type, context in [
diff --git a/readmeai/models/tokens.py b/readmeai/models/tokens.py
index 86446fc6..f66ea6e2 100644
--- a/readmeai/models/tokens.py
+++ b/readmeai/models/tokens.py
@@ -2,7 +2,7 @@
Tokenizer utilities for tokenizing and truncating text.
"""
-from tiktoken import get_encoding
+from tiktoken import Encoding, get_encoding
from readmeai.config.settings import Settings
from readmeai.core.logger import Logger
@@ -11,7 +11,7 @@
_logger = Logger(__name__)
-def _set_encoding_cache(encoding_name: str) -> str:
+def _set_encoding_cache(encoding_name: str) -> Encoding:
"""Set the encoding cache for a specific encoding."""
if encoding_name not in _encoding_cache:
_encoding_cache[encoding_name] = get_encoding(encoding_name)
@@ -19,7 +19,10 @@ def _set_encoding_cache(encoding_name: str) -> str:
async def token_handler(
- config: Settings, index: str, prompt: str, tokens: int
+ config: Settings,
+ index: str,
+ prompt: str,
+ tokens: int,
) -> str:
"""Handle token count for the prompt."""
encoder = config.llm.encoder
@@ -28,7 +31,7 @@ async def token_handler(
if token_count > max_count:
_logger.debug(
- f"Truncating '{index}' prompt: {token_count} > {max_count} tokens!"
+ f"Truncating '{index}' prompt: {token_count} > {max_count} tokens!",
)
prompt = truncate_tokens(encoder, prompt, tokens)
@@ -43,19 +46,19 @@ def count_tokens(text: str, encoder: str) -> int:
except (UnicodeEncodeError, ValueError) as exc:
_logger.error(
- f"Error counting tokens for '{text}' with {encoder}: {exc}"
+ f"Error counting tokens for '{text}' with {encoder}: {exc}",
)
token_count = 0
return token_count
-def truncate_tokens(encoder: str, text: str, max_count: int) -> str:
+def truncate_tokens(encoding: str, text: str, max_count: int) -> str:
"""Truncate a text string to a maximum number of tokens."""
if not text:
return text
try:
- encoder = _set_encoding_cache(encoder)
+ encoder = _set_encoding_cache(encoding)
token_count = len(encoder.encode(text))
if token_count <= max_count:
return text
@@ -70,7 +73,9 @@ def truncate_tokens(encoder: str, text: str, max_count: int) -> str:
def update_max_tokens(
- max_tokens: int, prompt: str, target: str = "Hello!"
+ max_tokens: int,
+ prompt: str,
+ target: str = "Hello!",
) -> int:
"""Adjust the maximum number of tokens based on the specific prompt."""
is_valid_prompt = prompt.strip().startswith(target.strip())
diff --git a/readmeai/parsers/cicd/bitbucket.py b/readmeai/parsers/cicd/bitbucket.py
deleted file mode 100644
index caf214b4..00000000
--- a/readmeai/parsers/cicd/bitbucket.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for Bitbucket Pipelines (bitbucket-pipelines.yml) configuration files."""
diff --git a/readmeai/parsers/cicd/circleci.py b/readmeai/parsers/cicd/circleci.py
deleted file mode 100644
index 39d49b91..00000000
--- a/readmeai/parsers/cicd/circleci.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for .circleci/config.yml configuration files."""
diff --git a/readmeai/parsers/cicd/github.py b/readmeai/parsers/cicd/github.py
deleted file mode 100644
index 6c46dc00..00000000
--- a/readmeai/parsers/cicd/github.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for GitHub Actions (.github/workflows/) configuration files."""
diff --git a/readmeai/parsers/cicd/gitlab.py b/readmeai/parsers/cicd/gitlab.py
deleted file mode 100644
index 2bdcbb22..00000000
--- a/readmeai/parsers/cicd/gitlab.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for .gitlab-ci.yml configuration files."""
diff --git a/readmeai/parsers/cicd/jenkins.py b/readmeai/parsers/cicd/jenkins.py
deleted file mode 100644
index 97912d5b..00000000
--- a/readmeai/parsers/cicd/jenkins.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for Jenkinsfile (Jenkinsfile) configuration files."""
diff --git a/readmeai/parsers/cicd/travis.py b/readmeai/parsers/cicd/travis.py
deleted file mode 100644
index 1d4cbc55..00000000
--- a/readmeai/parsers/cicd/travis.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for .travis.yml configuration files."""
diff --git a/readmeai/parsers/configuration/ansible.py b/readmeai/parsers/configuration/ansible.py
deleted file mode 100644
index bf1ce6a6..00000000
--- a/readmeai/parsers/configuration/ansible.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for Ansible (playbook.yml, ansible/site.yml) configuration files."""
diff --git a/readmeai/parsers/configuration/apache.py b/readmeai/parsers/configuration/apache.py
deleted file mode 100644
index e9fb3a3a..00000000
--- a/readmeai/parsers/configuration/apache.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for apache.py (httpd.conf) configuration files."""
diff --git a/readmeai/parsers/configuration/nginx.py b/readmeai/parsers/configuration/nginx.py
deleted file mode 100644
index 815324bf..00000000
--- a/readmeai/parsers/configuration/nginx.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for Nginx (nginx.conf) configuration files."""
diff --git a/readmeai/parsers/language/cpp.py b/readmeai/parsers/cpp.py
similarity index 81%
rename from readmeai/parsers/language/cpp.py
rename to readmeai/parsers/cpp.py
index ee0000fc..8c68d574 100644
--- a/readmeai/parsers/language/cpp.py
+++ b/readmeai/parsers/cpp.py
@@ -1,19 +1,22 @@
-"""Dependency file parsers for C/C++ projects."""
+"""
+Dependency file parsers for C/C++ projects.
+"""
import re
-from typing import List
from readmeai.core.parsers import BaseFileParser
class CMakeParser(BaseFileParser):
- """Parser for CMake dependency files."""
+ """
+ Parser for CMake dependency files.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts dependencies, libs, and software from a CMakeLists.txt."""
try:
extracted_dependencies = []
@@ -30,35 +33,40 @@ def parse(self, content: str) -> List[str]:
extracted_dependencies.extend(dependencies)
if line.startswith("target_link_libraries") or line.startswith(
- "find_package"
+ "find_package",
):
libs = re.findall(
- r"target_link_libraries\([^)]+\s+([^)]+)\)", line
+ r"target_link_libraries\([^)]+\s+([^)]+)\)",
+ line,
)
extracted_dependencies.extend(libs)
return list(set(extracted_dependencies))
except re.error as exc:
- return self.handle_parsing_error(f"CMakeLists.txt: {str(exc)}")
+ return self.handle_parsing_error(f"CMakeLists.txt: {exc!s}")
class ConfigureAcParser(BaseFileParser):
- """Parser for configure.ac dependency files."""
+ """
+ Parser for configure.ac dependency files.
+ """
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from a configure.ac file."""
try:
regex = re.compile(r"AC_CHECK_LIB\([^)]+\s+([^)]+)\)")
return regex.findall(content)
except re.error as exc:
- return self.handle_parsing_error(f"configure.ac: {str(exc)}")
+ return self.handle_parsing_error(f"configure.ac: {exc!s}")
class MakefileAmParser(BaseFileParser):
- """Parser for Makefile dependency files."""
+ """
+ Parser for Makefile dependency files.
+ """
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts dependencies from Makefile.am files."""
try:
extracted_packages = []
@@ -89,4 +97,4 @@ def parse(self, content: str) -> List[str]:
return list(set(extracted_packages))
except re.error as exc:
- return self.handle_parsing_error(f"Makefile.am: {str(exc)}")
+ return self.handle_parsing_error(f"Makefile.am: {exc!s}")
diff --git a/readmeai/parsers/configuration/docker.py b/readmeai/parsers/docker.py
similarity index 74%
rename from readmeai/parsers/configuration/docker.py
rename to readmeai/parsers/docker.py
index 9b31b7de..c7e99b65 100644
--- a/readmeai/parsers/configuration/docker.py
+++ b/readmeai/parsers/docker.py
@@ -1,7 +1,8 @@
-"""Parser for Docker (Dockerfile, docker-compose.yaml) configuration files."""
+"""
+Parser for Docker (Dockerfile, docker-compose.yaml) configuration files.
+"""
import re
-from typing import List
import yaml
@@ -9,13 +10,15 @@
class DockerfileParser(BaseFileParser):
- """Parser for Dockerfile dependency files."""
+ """
+ Parser for Dockerfile dependency files.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from a Dockerfile."""
try:
dependencies = []
@@ -35,13 +38,15 @@ def parse(self, content: str) -> List[str]:
return dependencies
except re.error as exc:
- return self.handle_parsing_error(f"Dockerfile: {str(exc)}")
+ return self.handle_parsing_error(f"Dockerfile: {exc!s}")
class DockerComposeParser(BaseFileParser):
- """Parser for Docker related files."""
+ """
+ Parser for Docker related files.
+ """
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Parse docker-compose.yaml file and return a list of services."""
try:
data = yaml.safe_load(content)
@@ -49,4 +54,4 @@ def parse(self, content: str) -> List[str]:
return list(data["services"].keys())
except yaml.YAMLError as exc:
- return self.handle_parsing_error(f"Dockerfile: {str(exc)}")
+ return self.handle_parsing_error(f"Dockerfile: {exc!s}")
diff --git a/readmeai/parsers/factory.py b/readmeai/parsers/factory.py
index 5af521b2..51e03289 100644
--- a/readmeai/parsers/factory.py
+++ b/readmeai/parsers/factory.py
@@ -1,78 +1,75 @@
-"""Abstract factory module for all project file parsers."""
-
-from typing import Dict, Type
+"""
+Abstract factory module for all project file parsers.
+"""
from readmeai.core.parsers import BaseFileParser
-from readmeai.parsers.configuration.docker import (
- DockerComposeParser,
- DockerfileParser,
-)
-from readmeai.parsers.configuration.properties import PropertiesParser
-from readmeai.parsers.language.cpp import (
+from readmeai.parsers.cpp import (
CMakeParser,
ConfigureAcParser,
MakefileAmParser,
)
-from readmeai.parsers.language.go import GoModParser
-from readmeai.parsers.language.python import (
- RequirementsParser,
- TomlParser,
- YamlParser,
+from readmeai.parsers.docker import (
+ DockerComposeParser,
+ DockerfileParser,
)
-from readmeai.parsers.language.rust import CargoTomlParser
-from readmeai.parsers.language.swift import SwiftPackageParser
-from readmeai.parsers.package.gradle import (
+from readmeai.parsers.go import GoModParser
+from readmeai.parsers.gradle import (
BuildGradleKtsParser,
BuildGradleParser,
)
-from readmeai.parsers.package.maven import MavenParser
-from readmeai.parsers.package.npm import PackageJsonParser
-from readmeai.parsers.package.yarn import YarnLockParser
-
-ParserRegistryType = dict[str, Type[BaseFileParser]]
+from readmeai.parsers.maven import MavenParser
+from readmeai.parsers.npm import PackageJsonParser
+from readmeai.parsers.properties import PropertiesParser
+from readmeai.parsers.python import (
+ RequirementsParser,
+ TomlParser,
+ YamlParser,
+)
+from readmeai.parsers.rust import CargoTomlParser
+from readmeai.parsers.swift import SwiftPackageParser
+from readmeai.parsers.yarn import YarnLockParser
-PARSER_REGISTRY = {
- # Configuration
- ".properties": PropertiesParser,
- # Language/Framework
- # Python
- "Pipfile": TomlParser(),
- "pyproject.toml": TomlParser(),
- "requirements.in": RequirementsParser(),
- "requirements.txt": RequirementsParser(),
- "requirements-dev.txt": RequirementsParser(),
- "requirements-test.txt": RequirementsParser(),
- "requirements-prod.txt": RequirementsParser(),
- "dev-requirements.txt": RequirementsParser(),
- "environment.yml": YamlParser(),
- "environment.yaml": YamlParser(),
- # "setup.py": setup_py_parser,
- # "setup.cfg": setup_cfg_parser,
- # C/C++
- "cmakeLists.txt": CMakeParser(),
- "configure.ac": ConfigureAcParser(),
- "Makefile.am": MakefileAmParser(),
- # JavaScript/Node.js
- "package.json": PackageJsonParser(),
- "yarn.lock": YarnLockParser(),
- # Kotlin and Kotlin DSL
- "build.gradle": BuildGradleParser(),
- "build.gradle.kts": BuildGradleKtsParser(),
- # Go
- "go.mod": GoModParser(),
- # Java
- "pom.xml": MavenParser(),
- # Rust
- "cargo.toml": CargoTomlParser(),
- # Swift
- "Package.swift": SwiftPackageParser(),
- "Dockerfile": DockerfileParser(),
- "docker-compose.yaml": DockerComposeParser(),
- # Package Managers
- # Monitoring and Logging
-}
+ParserRegistryType = dict[str, BaseFileParser]
-def parser_handler() -> Dict[str, BaseFileParser]:
- """Returns a dictionary of callable file parser methods."""
- return PARSER_REGISTRY
+def parser_handler() -> ParserRegistryType:
+ """
+ Returns a dictionary of callable file parser methods.
+ """
+ return {
+ # Python
+ "Pipfile": TomlParser(),
+ "pyproject.toml": TomlParser(),
+ "requirements.in": RequirementsParser(),
+ "requirements.txt": RequirementsParser(),
+ "requirements-dev.txt": RequirementsParser(),
+ "requirements-test.txt": RequirementsParser(),
+ "requirements-prod.txt": RequirementsParser(),
+ "dev-requirements.txt": RequirementsParser(),
+ "environment.yml": YamlParser(),
+ "environment.yaml": YamlParser(),
+ # "setup.py": setup_py_parser,
+ # "setup.cfg": setup_cfg_parser,
+ # C/C++
+ "cmakeLists.txt": CMakeParser(),
+ "configure.ac": ConfigureAcParser(),
+ "Makefile.am": MakefileAmParser(),
+ # JavaScript/Node.js
+ "package.json": PackageJsonParser(),
+ "yarn.lock": YarnLockParser(),
+ # Kotlin/Kotlin DSL
+ "build.gradle": BuildGradleParser(),
+ "build.gradle.kts": BuildGradleKtsParser(),
+ # Go
+ "go.mod": GoModParser(),
+ # Java
+ "pom.xml": MavenParser(),
+ # Rust
+ "cargo.toml": CargoTomlParser(),
+ # Swift
+ "Package.swift": SwiftPackageParser(),
+ # Docker
+ "Dockerfile": DockerfileParser(),
+ "docker-compose.yaml": DockerComposeParser(),
+ ".properties": PropertiesParser(),
+ }
diff --git a/readmeai/parsers/language/go.py b/readmeai/parsers/go.py
similarity index 75%
rename from readmeai/parsers/language/go.py
rename to readmeai/parsers/go.py
index 715d6815..656f353a 100644
--- a/readmeai/parsers/language/go.py
+++ b/readmeai/parsers/go.py
@@ -1,19 +1,22 @@
-"""Parse package dependencies from go.mod files."""
+"""
+Parser for go.mod dependency files.
+"""
import re
-from typing import List
from readmeai.core.parsers import BaseFileParser
class GoModParser(BaseFileParser):
- """Parser for go.mod files."""
+ """
+ Parser for go.mod files.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Parse the content of a go.mod file."""
try:
lines = content.split("\n")
@@ -27,4 +30,4 @@ def parse(self, content: str) -> List[str]:
return list(package_names)
except Exception as exc:
- return self.handle_parsing_error(f"go.mod: {str(exc)}")
+ return self.handle_parsing_error(f"go.mod: {exc!s}")
diff --git a/readmeai/parsers/package/gradle.py b/readmeai/parsers/gradle.py
similarity index 81%
rename from readmeai/parsers/package/gradle.py
rename to readmeai/parsers/gradle.py
index 613a5a9b..da27d28a 100644
--- a/readmeai/parsers/package/gradle.py
+++ b/readmeai/parsers/gradle.py
@@ -1,19 +1,22 @@
-"""Parser for gradle dependency files."""
+"""
+Parser for gradle dependency files.
+"""
import re
-from typing import List
from readmeai.core.parsers import BaseFileParser
class BuildGradleParser(BaseFileParser):
- """Parser for build.gradle dependency files."""
+ """
+ Parser for build.gradle dependency files.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from a build.gradle file."""
try:
pattern = r"(implementation|classpath|api|testImplementation|androidTestImplementation|kapt)\s+['\"]([^'\"]+)['\"]"
@@ -30,13 +33,15 @@ def parse(self, content: str) -> List[str]:
return list(package_names)
except re.error as exc:
- return self.handle_parsing_error(f"build.gradle: {str(exc)}")
+ return self.handle_parsing_error(f"build.gradle: {exc!s}")
class BuildGradleKtsParser(BaseFileParser):
- """Parser for build.gradle.kts dependency files."""
+ """
+ Parser for build.gradle.kts dependency files.
+ """
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from a build.gradle.kts file."""
try:
pattern = r"(\bimplementation|testImplementation)\s*\((['\"])([^'\"]+)\2\)"
@@ -52,4 +57,4 @@ def parse(self, content: str) -> List[str]:
return list(package_names)
except re.error as error:
- return self.handle_parsing_error(f"build.gradle.kts: {str(error)}")
+ return self.handle_parsing_error(f"build.gradle.kts: {error!s}")
diff --git a/readmeai/parsers/infrastructure/cloudformation.py b/readmeai/parsers/infrastructure/cloudformation.py
deleted file mode 100644
index 063fd2c1..00000000
--- a/readmeai/parsers/infrastructure/cloudformation.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for cloudformation.yaml (AWS CloudFormation) configuration files."""
diff --git a/readmeai/parsers/infrastructure/terraform.py b/readmeai/parsers/infrastructure/terraform.py
deleted file mode 100644
index 6e873666..00000000
--- a/readmeai/parsers/infrastructure/terraform.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for main.tf (Terraform) configuration files."""
diff --git a/readmeai/parsers/package/maven.py b/readmeai/parsers/maven.py
similarity index 70%
rename from readmeai/parsers/package/maven.py
rename to readmeai/parsers/maven.py
index 316e16a0..c3f63c3a 100644
--- a/readmeai/parsers/package/maven.py
+++ b/readmeai/parsers/maven.py
@@ -1,23 +1,26 @@
-"""Parser utilities for Java-based dependency files."""
+"""
+Parser utilities for Java-based dependency files.
+"""
import re
-from typing import List
from readmeai.core.parsers import BaseFileParser
class MavenParser(BaseFileParser):
- """Parser for Maven dependency files in pom.xml format."""
+ """
+ Parser for Maven dependency files in pom.xml format.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extract packages names from Maven pom.xml files."""
try:
regex = re.compile(
- r"\s*([^<]+)\s*([^<]+)\s*([^<]+)"
+ r"\s*([^<]+)\s*([^<]+)\s*([^<]+)",
)
matches = regex.findall(content)
dependencies = [
@@ -28,4 +31,4 @@ def parse(self, content: str) -> List[str]:
return set(dependencies)
except re.error as exc:
- return self.handle_parsing_error(f"pom.xml: {str(exc)}")
+ return self.handle_parsing_error(f"pom.xml: {exc!s}")
diff --git a/readmeai/parsers/package/npm.py b/readmeai/parsers/npm.py
similarity index 69%
rename from readmeai/parsers/package/npm.py
rename to readmeai/parsers/npm.py
index 658536ac..5720d444 100644
--- a/readmeai/parsers/package/npm.py
+++ b/readmeai/parsers/npm.py
@@ -1,20 +1,23 @@
-"""File for parsing json dependency files."""
+"""
+Parsers for npm related dependency files.
+"""
import json
import re
-from typing import List
from readmeai.core.parsers import BaseFileParser
class PackageJsonParser(BaseFileParser):
- """Parser for package.json dependency files."""
+ """
+ Parser for package.json dependency files.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Returns a list of dependencies parsed from a json file."""
try:
data = json.loads(content)
@@ -29,15 +32,17 @@ def parse(self, content: str) -> List[str]:
return package_names
except json.JSONDecodeError as exc:
- return self.handle_parsing_error(f"package.json: {str(exc)}")
+ return self.handle_parsing_error(f"package.json: {exc!s}")
class YarnLockParser(BaseFileParser):
- """Parser for yarn.lock dependency files."""
+ """
+ Parser for yarn.lock dependency files.
+ """
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from a yarn.lock file."""
try:
return re.findall(r"(\S+)(?=@)", content)
except re.error as exc:
- return self.handle_parsing_error(f"yarn.lock: {str(exc)}")
+ return self.handle_parsing_error(f"yarn.lock: {exc!s}")
diff --git a/readmeai/parsers/orchestration/kubernetes.py b/readmeai/parsers/orchestration/kubernetes.py
deleted file mode 100644
index f32cdc6c..00000000
--- a/readmeai/parsers/orchestration/kubernetes.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for Kubernetes (k8s.yml) configuration files."""
diff --git a/readmeai/parsers/package/__init__.py b/readmeai/parsers/package/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/readmeai/parsers/package/composer.py b/readmeai/parsers/package/composer.py
deleted file mode 100644
index 2d104b0e..00000000
--- a/readmeai/parsers/package/composer.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for PHP Composer (composer.json) configuration files."""
diff --git a/readmeai/parsers/package/gem.py b/readmeai/parsers/package/gem.py
deleted file mode 100644
index a214954a..00000000
--- a/readmeai/parsers/package/gem.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for Gemfile.lock (Ruby) configuration files."""
diff --git a/readmeai/parsers/package/nuget.py b/readmeai/parsers/package/nuget.py
deleted file mode 100644
index c12db135..00000000
--- a/readmeai/parsers/package/nuget.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for NuGet.Config (.NET) configuration files."""
diff --git a/readmeai/parsers/package/pip.py b/readmeai/parsers/package/pip.py
deleted file mode 100644
index 5c7b8517..00000000
--- a/readmeai/parsers/package/pip.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Parser for Pip (requirements.txt, Pipfile) configuration files."""
diff --git a/readmeai/parsers/configuration/properties.py b/readmeai/parsers/properties.py
similarity index 77%
rename from readmeai/parsers/configuration/properties.py
rename to readmeai/parsers/properties.py
index 1c9f1107..83f1ec58 100644
--- a/readmeai/parsers/configuration/properties.py
+++ b/readmeai/parsers/properties.py
@@ -1,15 +1,18 @@
-"""Parser for .properties configuration files."""
+"""
+Parser for .properties configuration files.
+"""
import re
-from typing import List
from readmeai.core.parsers import BaseFileParser
class PropertiesParser(BaseFileParser):
- """Parser for .properties files."""
+ """
+ Parser for .properties files.
+ """
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Parse the content of a .properties file."""
names = []
diff --git a/readmeai/parsers/language/python.py b/readmeai/parsers/python.py
similarity index 90%
rename from readmeai/parsers/language/python.py
rename to readmeai/parsers/python.py
index 2b7a845c..91e60a58 100644
--- a/readmeai/parsers/language/python.py
+++ b/readmeai/parsers/python.py
@@ -1,27 +1,30 @@
-"""Python dependency file parsers methods."""
+"""
+Python dependency file parsers methods.
+"""
import re
import sys
-from typing import List
import yaml
from readmeai.core.parsers import BaseFileParser
if sys.version_info < (3, 11):
- import toml
+ import tomli as toml
else:
import tomllib as toml
class RequirementsParser(BaseFileParser):
- """Parser for requirements.txt files."""
+ """
+ Parser for requirements.txt files.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""
Extracts package names from a requirements.txt file.
Excludes the version specifiers.
@@ -39,7 +42,7 @@ def parse(self, content: str) -> List[str]:
return package_names
except re.error as exc:
- return self.handle_parsing_error(f"requirements.txt: {str(exc)}")
+ return self.handle_parsing_error(f"requirements.txt: {exc!s}")
class TomlParser(BaseFileParser):
@@ -48,7 +51,7 @@ class TomlParser(BaseFileParser):
Handles build systems like Pipenv, Poetry, and Flit.
"""
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from a TOML file."""
try:
data = toml.loads(content)
@@ -66,25 +69,25 @@ def parse(self, content: str) -> List[str]:
if "dev-dependencies" in poetry_data:
dependencies.extend(
- poetry_data.get("dev-dependencies", {}).keys()
+ poetry_data.get("dev-dependencies", {}).keys(),
)
if "group" in poetry_data and "dev" in poetry_data["group"]:
poetry_data_dev = data["tool"]["poetry"]["group"]["dev"]
dependencies.extend(
- poetry_data_dev.get("dependencies", {}).keys()
+ poetry_data_dev.get("dependencies", {}).keys(),
)
if "group" in poetry_data and "test" in poetry_data["group"]:
poetry_data_main = data["tool"]["poetry"]["group"]["test"]
dependencies.extend(
- poetry_data_main.get("dependencies", {}).keys()
+ poetry_data_main.get("dependencies", {}).keys(),
)
if "group" in poetry_data and "docs" in poetry_data["group"]:
poetry_data_main = data["tool"]["poetry"]["group"]["docs"]
dependencies.extend(
- poetry_data_main.get("dependencies", {}).keys()
+ poetry_data_main.get("dependencies", {}).keys(),
)
return dependencies
@@ -92,7 +95,7 @@ def parse(self, content: str) -> List[str]:
# For pyproject.toml (Flit)
elif "project" in data and "dependencies" in data["project"]:
dependencies = self.extract_package_names(
- data["project"]["dependencies"]
+ data["project"]["dependencies"],
)
if (
"project" in data
@@ -102,7 +105,7 @@ def parse(self, content: str) -> List[str]:
"optional-dependencies"
].values():
dependencies.extend(
- self.extract_package_names(group_deps)
+ self.extract_package_names(group_deps),
)
else:
dependencies = []
@@ -110,9 +113,9 @@ def parse(self, content: str) -> List[str]:
return dependencies
except Exception as exc:
- return self.handle_parsing_error(f"pyproject.toml: {str(exc)}")
+ return self.handle_parsing_error(f"pyproject.toml: {exc!s}")
- def extract_package_names(self, dependencies: List[str]) -> List[str]:
+ def extract_package_names(self, dependencies: list[str]) -> list[str]:
"""Helper method to extract package names from dependency strings."""
package_names = []
for dep in dependencies:
@@ -127,7 +130,7 @@ class YamlParser(BaseFileParser):
Parser for Python YAML based dependency files i.e. environment.yml
"""
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from environment.yml file."""
try:
data = yaml.safe_load(content)
@@ -136,7 +139,7 @@ def parse(self, content: str) -> List[str]:
for package in data["dependencies"]:
if isinstance(package, str):
dependencies.append(
- package.split("=")[0].split(">")[0].split("<")[0]
+ package.split("=")[0].split(">")[0].split("<")[0],
)
elif isinstance(package, dict):
for pip_package in package.values():
@@ -147,5 +150,5 @@ def parse(self, content: str) -> List[str]:
except yaml.YAMLError as exc:
return self.handle_parsing_error(
- f"conda environment.yml: {str(exc)}"
+ f"conda environment.yml: {exc!s}",
)
diff --git a/readmeai/parsers/language/rust.py b/readmeai/parsers/rust.py
similarity index 78%
rename from readmeai/parsers/language/rust.py
rename to readmeai/parsers/rust.py
index 6a8823b1..bd3fbba6 100644
--- a/readmeai/parsers/language/rust.py
+++ b/readmeai/parsers/rust.py
@@ -3,24 +3,25 @@
"""
import sys
-from typing import List
from readmeai.core.parsers import BaseFileParser
if sys.version_info < (3, 11):
- import toml
+ import tomli as toml
else:
import tomllib as toml
class CargoTomlParser(BaseFileParser):
- """Parser for Rust cargo.toml dependency files."""
+ """
+ Parser for Rust cargo.toml dependency files.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extract packages names from Rust TOML files."""
try:
data = toml.loads(content)
@@ -33,11 +34,12 @@ def parse(self, content: str) -> List[str]:
for key in data:
if key.startswith("dependencies.") and isinstance(
- data[key], dict
+ data[key],
+ dict,
):
dependencies.extend(data[key].keys())
return dependencies
except Exception as exc:
- return self.handle_parsing_error(f"cargo.toml: {str(exc)}")
+ return self.handle_parsing_error(f"cargo.toml: {exc!s}")
diff --git a/readmeai/parsers/language/swift.py b/readmeai/parsers/swift.py
similarity index 86%
rename from readmeai/parsers/language/swift.py
rename to readmeai/parsers/swift.py
index bbb402a2..d294d184 100644
--- a/readmeai/parsers/language/swift.py
+++ b/readmeai/parsers/swift.py
@@ -1,19 +1,22 @@
-"""Dependency file parsers for Swift projects."""
+"""
+Dependency file parsers for Swift projects.
+"""
import re
-from typing import List
from readmeai.core.parsers import BaseFileParser
class SwiftPackageParser(BaseFileParser):
- """Parser for Swift Package.swift files."""
+ """
+ Parser for Swift Package.swift files.
+ """
def __init__(self) -> None:
"""Initializes the handler with given configuration."""
super().__init__()
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from a Package.swift file."""
try:
package_names = set()
@@ -41,7 +44,7 @@ def parse(self, content: str) -> List[str]:
return list(package_names)
except Exception as exc:
- return self.handle_parsing_error(f"Package.swift: {str(exc)}")
+ return self.handle_parsing_error(f"Package.swift: {exc!s}")
@staticmethod
def extract_package_name_from_url(url: str) -> str:
diff --git a/readmeai/parsers/package/yarn.py b/readmeai/parsers/yarn.py
similarity index 52%
rename from readmeai/parsers/package/yarn.py
rename to readmeai/parsers/yarn.py
index dd60b32c..17506946 100644
--- a/readmeai/parsers/package/yarn.py
+++ b/readmeai/parsers/yarn.py
@@ -1,17 +1,20 @@
-"""Parser for yarn.lock dependency files."""
+"""
+Parser for yarn.lock dependency files.
+"""
import re
-from typing import List
from readmeai.core.parsers import BaseFileParser
class YarnLockParser(BaseFileParser):
- """Parser for yarn.lock dependency files."""
+ """
+ Parser for yarn.lock dependency files.
+ """
- def parse(self, content: str) -> List[str]:
+ def parse(self, content: str) -> list[str]:
"""Extracts package names from a yarn.lock file."""
try:
return re.findall(r"(\S+)(?=@)", content)
except re.error as exc:
- return self.handle_parsing_error(f"yarn.lock: {str(exc)}")
+ return self.handle_parsing_error(f"yarn.lock: {exc!s}")
diff --git a/readmeai/services/__init__.py b/readmeai/services/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/readmeai/services/git.py b/readmeai/services/git.py
deleted file mode 100644
index a6c4c06b..00000000
--- a/readmeai/services/git.py
+++ /dev/null
@@ -1,186 +0,0 @@
-"""
-Git operations for cloning and validating user repositories.
-"""
-
-import os
-import platform
-import shutil
-from enum import Enum
-from pathlib import Path
-from typing import Optional
-
-import git
-
-from readmeai._exceptions import GitCloneError
-from readmeai.core.logger import Logger
-
-_logger = Logger(__name__)
-
-
-class GitHost(str, Enum):
- """
- Enum class for Git service providers. Enum data includes the following:
- - domain name of the Git service
- - api url to fetch repository details
- - file url to format links in the generated README.md file
- """
-
- LOCAL = "local"
- GITHUB = "github.com"
- GITLAB = "gitlab.com"
- BITBUCKET = "bitbucket.org"
-
- @property
- def api_url(self):
- """Gets the API URL for the Git service."""
- api_urls = {
- "local": None,
- "github.com": "https://api.github.com/repos/",
- "gitlab.com": "https://api.gitlab.com/v4/projects/",
- "bitbucket.org": "https://api.bitbucket.org/2.0/repositories/",
- }
- return api_urls[self.value]
-
- @property
- def file_url_template(self):
- """Gets the file URL template for accessing files on the Git service."""
- file_url_templates = {
- "local": "{file_path}",
- "github.com": "https://github.com/{full_name}/blob/master/{file_path}",
- "gitlab.com": "https://gitlab.com/{full_name}/-/blob/master/{file_path}",
- "bitbucket.org": "https://bitbucket.org/{full_name}/src/master/{file_path}",
- }
- return file_url_templates[self.value]
-
-
-async def clone_repository(repository: str, temp_dir: str) -> str:
- """Clone repository to temporary directory and return the path."""
- try:
- temp_dir_path = Path(temp_dir)
- if not temp_dir_path.exists():
- temp_dir_path.mkdir(parents=True)
-
- if Path(repository).is_dir():
- repo = git.Repo.init(temp_dir)
- origin = repo.create_remote(
- "origin", f"file://{Path(repository).absolute()}"
- )
- repo.git.config("core.sparseCheckout", "true")
-
- sparse_checkout_path = (
- temp_dir_path / ".git" / "info" / "sparse-checkout"
- )
- with sparse_checkout_path.open("w") as sc_file:
- sc_file.write("/*\n!.git/\n")
-
- origin.fetch()
- repo.git.checkout("FETCH_HEAD")
- else:
- git.Repo.clone_from(
- repository, temp_dir, depth=1, single_branch=True
- )
-
- await remove_hidden_contents(temp_dir_path)
-
- return temp_dir
-
- except (
- git.GitCommandError,
- git.InvalidGitRepositoryError,
- git.NoSuchPathError,
- ) as exc:
- raise GitCloneError(f"Error cloning repository: {str(exc)}") from exc
-
-
-async def remove_hidden_contents(directory: Path) -> None:
- """Remove hidden files and directories from a specified directory."""
- for item in directory.iterdir():
- if item.name.startswith(".") and item.name != ".github":
- if item.is_dir():
- shutil.rmtree(item)
- else:
- item.unlink()
-
-
-async def fetch_git_api_url(repo_url: str) -> str:
- """Parses the repository URL and returns the API URL."""
- try:
- parts = repo_url.rstrip("/").split("/")
- repo_name = f"{parts[-2]}/{parts[-1]}"
- for service in GitHost:
- if service in repo_url:
- api_url = f"{service.api_url}{repo_name}"
- _logger.info(f"{service.name.upper()} API URL: {api_url}")
- return api_url
-
- raise ValueError("Unsupported Git service.")
-
- except (IndexError, ValueError) as exc:
- raise ValueError(f"Invalid repository URL: {repo_url}") from exc
-
-
-def fetch_git_file_url(file_path: str, full_name: str, repo_url: str) -> str:
- """Returns the URL of the file in the remote repository."""
- if Path(repo_url).exists():
- return GitHost.LOCAL.file_url_template.format(file_path=file_path)
-
- for service in GitHost:
- if service in repo_url:
- return service.file_url_template.format(
- full_name=full_name, file_path=file_path
- )
-
- return file_path
-
-
-def find_git_executable() -> Optional[Path]:
- """Find the path to the git executable, if available."""
- try:
- git_exec_path = os.environ.get("GIT_PYTHON_GIT_EXECUTABLE")
- if git_exec_path:
- return Path(git_exec_path)
-
- # For Windows, set default location of git executable.
- if platform.system() == "Windows":
- default_windows_path = Path("C:\\Program Files\\Git\\cmd\\git.EXE")
- if default_windows_path.exists():
- return default_windows_path
-
- # For other OS, set executable path from PATH environment variable.
- paths = os.environ["PATH"].split(os.pathsep)
- for path in paths:
- git_path = Path(path) / "git"
- if git_path.exists():
- return git_path
-
- return None
-
- except Exception as exc:
- raise ValueError("Error finding Git executable") from exc
-
-
-def validate_file_permissions(temp_dir: Path) -> None:
- """Validates file permissions of the cloned repository."""
- try:
- if platform.system() != "Windows":
- permissions = temp_dir.stat().st_mode & 0o777
- if permissions != 0o700:
- raise SystemExit(
- f"Invalid file permissions for {temp_dir}.\n"
- f"Expected 0o700, but found {oct(permissions)}."
- )
-
- except Exception as exc:
- raise ValueError(
- f"Error validating file permissions: {str(exc)}"
- ) from exc
-
-
-def validate_git_executable(git_exec_path: str) -> None:
- """Validate the path to the git executable."""
- try:
- if not git_exec_path or not Path(git_exec_path).exists():
- raise ValueError(f"Git executable not found at {git_exec_path}")
-
- except Exception as exc:
- raise ValueError("Error validating Git executable path") from exc
diff --git a/readmeai/templates/__init__.py b/readmeai/templates/__init__.py
new file mode 100644
index 00000000..88a56f3d
--- /dev/null
+++ b/readmeai/templates/__init__.py
@@ -0,0 +1,11 @@
+from .base_template import BaseTemplate
+from .header import HeaderStyle, HeaderTemplate
+from .toc import ToCStyle, ToCTemplate
+
+__all__ = [
+ "BaseTemplate",
+ "HeaderTemplate",
+ "HeaderStyle",
+ "ToCTemplate",
+ "ToCStyle",
+]
diff --git a/readmeai/templates/base_template.py b/readmeai/templates/base_template.py
new file mode 100644
index 00000000..764af606
--- /dev/null
+++ b/readmeai/templates/base_template.py
@@ -0,0 +1,34 @@
+from abc import ABC, abstractmethod
+from typing import Any
+
+
+class BaseTemplate(ABC):
+ """
+ Base class for all templates.
+ """
+
+ @abstractmethod
+ def render(self, data: dict[str, Any]) -> str:
+ """
+ Render the template with the given data.
+
+ Args:
+ data (Dict[str, Any]): The data to use for rendering the template.
+
+ Returns:
+ str: The rendered template as a string.
+ """
+ ...
+
+ @staticmethod
+ def sanitize_input(input_str: str) -> str:
+ """
+ Sanitize input string to prevent XSS attacks.
+
+ Args:
+ input_str (str): The input string to sanitize.
+
+ Returns:
+ str: The sanitized string.
+ """
+ return input_str.replace("<", "<").replace(">", ">")
diff --git a/readmeai/templates/header.py b/readmeai/templates/header.py
new file mode 100644
index 00000000..8bcf36e6
--- /dev/null
+++ b/readmeai/templates/header.py
@@ -0,0 +1,87 @@
+import enum
+from typing import Any, ClassVar
+
+from .base_template import BaseTemplate
+
+
+class HeaderStyle(enum.StrEnum):
+ """
+ Enum containing header styles for the README file.
+ """
+
+ CLASSIC = enum.auto()
+ COMPACT = enum.auto()
+ MODERN = enum.auto()
+
+
+class HeaderTemplate(BaseTemplate):
+ """
+ Class variable for rendering the README.md header style.
+ """
+
+ HEADER_TEMPLATES: ClassVar[dict] = {
+ HeaderStyle.CLASSIC: """\
+
+ 
+
+
+
{repo_name}
+
+
+ {slogan}
+
+
\n\t{shields_icons}
+
\n\t{badge_icons}
+
+
+""",
+ HeaderStyle.COMPACT: """\
+[
]()
+
+## {repo_name}
+
+ *{slogan}*
+
+
\n\t{shields_icons}
+
+
+""",
+ HeaderStyle.MODERN.value: """\
+[
]()
+
+# `{repo_name}`
+
+#### {slogan}
+
+
\n\t{shields_icons}
+
\n\t{badge_icons}
+
+
+""",
+ }
+
+ def __init__(self, style: str = HeaderStyle.CLASSIC) -> None:
+ """
+ Initialize the header template with the given style.
+ """
+ self.style = style
+
+ def render(self, data: dict[str, Any]) -> str:
+ """
+ Render the header based on the current style and given data.
+ """
+ template = self.HEADER_TEMPLATES.get(
+ self.style,
+ self.HEADER_TEMPLATES[HeaderStyle.CLASSIC],
+ )
+ return template.format(**data)
+
+ @staticmethod
+ def get_header_template(template: str) -> str:
+ """
+ Get the header template for the given style.
+ """
+ try:
+ return HeaderTemplate.HEADER_TEMPLATES[HeaderStyle(template)]
+ except ValueError:
+ return HeaderTemplate.HEADER_TEMPLATES[HeaderStyle.CLASSIC]
diff --git a/readmeai/templates/toc.py b/readmeai/templates/toc.py
new file mode 100644
index 00000000..3e51fdd5
--- /dev/null
+++ b/readmeai/templates/toc.py
@@ -0,0 +1,103 @@
+import re
+from enum import Enum
+from typing import Any, ClassVar
+
+from .base_template import BaseTemplate
+
+
+class ToCStyle(Enum):
+ """
+ Enum for Table of Contents template styles.
+ """
+
+ BULLET = "bullet"
+ FOLD = "fold"
+ LINKS = "links"
+ NUMBER = "number"
+
+
+class ToCTemplate(BaseTemplate):
+ """
+ Class variable for rendering the README.md Table of Contents.
+ """
+
+ TOC_TEMPLATES: ClassVar[dict] = {
+ ToCStyle.BULLET: """##### ๐ Table of Contents\n\n{toc_items}\n---\n""",
+ ToCStyle.FOLD: """
Table of Contents
\n\n{toc_items}\n\n
\n""",
+ ToCStyle.NUMBER: """##### ๐ Table of Contents\n\n{toc_items}\n---\n""",
+ ToCStyle.LINKS: """##### ๐ Quick Links\n\n{toc_items}\n---\n""",
+ }
+
+ TOC_ITEM_TEMPLATES: ClassVar[dict[ToCStyle, str]] = {
+ ToCStyle.BULLET: "- [{title}](#{anchor})\n",
+ ToCStyle.FOLD: "- [{title}](#{anchor})\n",
+ ToCStyle.NUMBER: "{number}. [{title}](#{anchor})\n",
+ ToCStyle.LINKS: "- [{title}](#{anchor})\n",
+ }
+
+ def __init__(self, style: str = ToCStyle.BULLET.value) -> None:
+ """
+ Initialize the Table of Contents template with the given style.
+ """
+ self.style = ToCStyle(style)
+
+ @staticmethod
+ def generate_anchor(title: str) -> str:
+ """
+ Generate an anchor link from the given title.
+ """
+ title = re.sub(r":[a-zA-Z0-9_+-]+:", "", title)
+ anchor = title.lower().replace(" ", "-")
+ anchor = re.sub(r"[^\w-]", "", anchor)
+ return anchor
+
+ def _generate_toc_items(
+ self,
+ sections: list[dict[str, Any]],
+ level: int = 0,
+ parent_number: str = "",
+ ) -> str:
+ """
+ Generate Table of Contents items recursively.
+ """
+ toc = ""
+ for index, section in enumerate(sections, start=1):
+ indent = " " * level
+ anchor = self.generate_anchor(section["title"])
+ if self.style == ToCStyle.NUMBER:
+ number = (
+ f"{parent_number}{index}" if parent_number else str(index)
+ )
+ item = self.TOC_ITEM_TEMPLATES[self.style].format(
+ number=number,
+ title=section["title"],
+ anchor=anchor,
+ )
+ else:
+ item = self.TOC_ITEM_TEMPLATES[self.style].format(
+ title=section["title"],
+ anchor=anchor,
+ )
+ toc += f"{indent}{item}"
+ if "subsections" in section:
+ toc += self._generate_toc_items(
+ section["subsections"],
+ level + 2,
+ f"{number}." if self.style == ToCStyle.NUMBER else "",
+ )
+ return toc
+
+ def render(self, data: dict[str, Any]) -> str:
+ """
+ Render Table of Contents based on the current style and data.
+ """
+ toc_items = self._generate_toc_items(data["sections"])
+ template = self.TOC_TEMPLATES[self.style]
+ return template.format(toc_items=toc_items)
+
+ @staticmethod
+ def get_toc_template(template: str) -> str:
+ """
+ Get the Table of Contents template for the given style.
+ """
+ return ToCTemplate.TOC_TEMPLATES[ToCStyle(template)]
diff --git a/readmeai/utils/file_handler.py b/readmeai/utils/file_handler.py
index 3bcbf208..5157397a 100644
--- a/readmeai/utils/file_handler.py
+++ b/readmeai/utils/file_handler.py
@@ -5,8 +5,9 @@
import functools
import json
import sys
+from collections.abc import Callable
from pathlib import Path
-from typing import Any, Callable, Dict, Union
+from typing import Any
import yaml
@@ -23,7 +24,7 @@ class FileHandler:
def __init__(self):
"""Initialize the file handler."""
- self.file_actions: Dict[str, Dict[str, Callable[[str], Any]]] = {
+ self.file_actions: dict[str, dict[str, Callable[[str], Any]]] = {
"json": {"read": self.read_json, "write": self.write_json},
"md": {"read": self.read_markdown, "write": self.write_markdown},
"toml": {"read": self.read_toml, "write": self.write_toml},
@@ -34,7 +35,7 @@ def __init__(self):
self.read_json = functools.lru_cache(maxsize=100)(self.read_json)
self.read_toml = functools.lru_cache(maxsize=100)(self.read_toml)
- def read(self, file_path: Union[str, Path]) -> Any:
+ def read(self, file_path: str | Path) -> Any:
"""Read the content of a file."""
if file_path in self.cache:
return self.cache[file_path]
@@ -48,7 +49,7 @@ def read(self, file_path: Union[str, Path]) -> Any:
except Exception as exc:
raise FileReadError(exc, file_path) from exc
- def write(self, file_path: Union[str, Path], content: Any) -> None:
+ def write(self, file_path: str | Path, content: Any) -> None:
"""Write the content to a file."""
try:
file_extension = str(file_path).rsplit(".", maxsplit=1)[-1]
@@ -73,20 +74,20 @@ def get_action(
@staticmethod
@functools.lru_cache(maxsize=100)
- def read_json(file_path: Union[str, Path]) -> Dict[str, Any]:
+ def read_json(file_path: str | Path) -> dict[str, Any]:
"""Read the content of a JSON file."""
with open(file_path, encoding="utf-8") as file:
return json.load(file)
@staticmethod
- def read_markdown(file_path: Union[str, Path]) -> str:
+ def read_markdown(file_path: str | Path) -> str:
"""Read the content of a Markdown file."""
with open(file_path, encoding="utf-8") as file:
return file.read()
@staticmethod
@functools.lru_cache(maxsize=100)
- def read_toml(file_path: Union[str, Path]) -> Dict[str, Any]:
+ def read_toml(file_path: str | Path) -> dict[str, Any]:
"""Read the content of a TOML file."""
if sys.version_info < (3, 11):
with open(file_path, encoding="utf-8") as file:
@@ -97,49 +98,43 @@ def read_toml(file_path: Union[str, Path]) -> Dict[str, Any]:
return {key.lower(): value for key, value in data.items()}
@staticmethod
- def read_text(file_path: Union[str, Path]) -> str:
+ def read_text(file_path: str | Path) -> str:
"""Read the content of a TXT file."""
with open(file_path, encoding="utf-8") as file:
return file.read()
@staticmethod
- def read_yaml(file_path: Union[str, Path]) -> Dict[str, Any]:
+ def read_yaml(file_path: str | Path) -> dict[str, Any]:
"""Read the content of a YAML file."""
with open(file_path, encoding="utf-8") as file:
return yaml.safe_load(file)
@staticmethod
- def write_json(
- file_path: Union[str, Path], content: Dict[str, Any]
- ) -> None:
+ def write_json(file_path: str | Path, content: dict[str, Any]) -> None:
"""Write the content to a JSON file."""
with open(file_path, "w", encoding="utf-8") as file:
json.dump(content, file, indent=4)
@staticmethod
- def write_markdown(file_path: Union[str, Path], content: str) -> None:
+ def write_markdown(file_path: str | Path, content: str) -> None:
"""Write the content to a Markdown file."""
with open(file_path, "w", encoding="utf-8") as file:
file.write(content)
@staticmethod
- def write_toml(
- file_path: Union[str, Path], content: Dict[str, Any]
- ) -> None:
+ def write_toml(file_path: str | Path, content: dict[str, Any]) -> None:
"""Write the content to a TOML file."""
with open(file_path, "w", encoding="utf-8") as file:
toml.dump(content, file)
@staticmethod
- def write_text(file_path: Union[str, Path], content: str) -> None:
+ def write_text(file_path: str | Path, content: str) -> None:
"""Write the content to a TXT file."""
with open(file_path, "w", encoding="utf-8") as file:
file.write(content)
@staticmethod
- def write_yaml(
- file_path: Union[str, Path], content: Dict[str, Any]
- ) -> None:
+ def write_yaml(file_path: str | Path, content: dict[str, Any]) -> None:
"""Write the content to a YAML file."""
with open(file_path, "w", encoding="utf-8") as file:
yaml.safe_dump(content, file)
diff --git a/readmeai/utils/file_resources.py b/readmeai/utils/file_resources.py
index a8117ad9..653f8d0f 100644
--- a/readmeai/utils/file_resources.py
+++ b/readmeai/utils/file_resources.py
@@ -11,8 +11,8 @@
def get_resource_path(
file_path: str,
package: str = "readmeai.config",
- sub_module: str = "settings",
-) -> Path:
+ submodule: str = "settings",
+) -> str:
"""Retrieves the path to a resource file within the package.
This function attempts to first use `importlib.resources` for preferred
@@ -41,28 +41,27 @@ def get_resource_path(
"""
resource_path = None
try:
- resource_path = resources.files(package).joinpath(
- sub_module, file_path
- )
+ resource_path = resources.files(package).joinpath(submodule, file_path)
except TypeError: # pragma: no cover
try:
import pkg_resources
- submodule = sub_module.replace(".", "/")
+ submodule = submodule.replace(".", "/")
resource_path = Path(
pkg_resources.resource_filename(
- "readmeai", f"{submodule}/{file_path}"
- )
+ "readmeai",
+ f"{submodule}/{file_path}",
+ ),
).resolve()
except Exception as exc: # pragma: no cover
raise FileReadError(
- "Error loading resource file using pkg_resources",
+ "Error loading resource file via pkg_resources",
str(resource_path),
) from exc
- if not resource_path.exists():
+ if resource_path is None:
raise FileReadError("Resource file not found", str(resource_path))
- return resource_path
+ return str(resource_path)
diff --git a/readmeai/vcs/__init__.py b/readmeai/vcs/__init__.py
new file mode 100644
index 00000000..caac7c45
--- /dev/null
+++ b/readmeai/vcs/__init__.py
@@ -0,0 +1,34 @@
+from .errors import (
+ GitCloneError,
+ GitURLError,
+ GitValidationError,
+ UnsupportedGitHostError,
+)
+from .ingestor import retrieve_repository
+from .metadata import (
+ RepositoryMetadata,
+ _fetch_repository_metadata,
+ fetch_git_repository_metadata,
+)
+from .providers import GitHost, get_file_url, parse_git_url
+from .url_builder import GitURL
+
+__all__ = [
+ "GitHost",
+ "GitURL",
+ "GitURL.validate_url",
+ "GitURL.set_attributes",
+ "GitURL.create",
+ "GitURL.git_file_url",
+ "GitURL.git_api_url",
+ "get_file_url",
+ "parse_git_url",
+ "retrieve_repository",
+ "GitValidationError",
+ "GitCloneError",
+ "GitURLError",
+ "UnsupportedGitHostError",
+ "RepositoryMetadata",
+ "fetch_git_repository_metadata",
+ "_fetch_repository_metadata",
+]
diff --git a/readmeai/vcs/errors.py b/readmeai/vcs/errors.py
new file mode 100644
index 00000000..549f8539
--- /dev/null
+++ b/readmeai/vcs/errors.py
@@ -0,0 +1,45 @@
+"""
+Custom exceptions for the utilities package.
+"""
+
+from __future__ import annotations
+
+from readmeai._exceptions import ReadmeAIError
+
+
+class GitValidationError(ReadmeAIError):
+ """
+ Base class errors validating Git repositories.
+ """
+
+ ...
+
+
+class GitCloneError(GitValidationError):
+ """
+ Raised when a Git repository cannot be cloned.
+ """
+
+ def __init__(self, repository: str, *args):
+ self.repository = repository
+ super().__init__(f"Failed to clone repository: {repository}", *args)
+
+
+class GitURLError(GitValidationError):
+ """
+ Raised when an invalid Git repository URL is provided.
+ """
+
+ def __init__(self, url: str, *args):
+ self.url = url
+ super().__init__(f"Invalid Git repository URL: {url}", *args)
+
+
+class UnsupportedGitHostError(GitValidationError):
+ """
+ Raised when an unsupported Git host is provided.
+ """
+
+ def __init__(self, host: str, *args):
+ self.host = host
+ super().__init__(f"Unsupported Git host: {host}", *args)
diff --git a/readmeai/vcs/ingestor.py b/readmeai/vcs/ingestor.py
new file mode 100644
index 00000000..ba57d169
--- /dev/null
+++ b/readmeai/vcs/ingestor.py
@@ -0,0 +1,109 @@
+import asyncio
+import os
+import platform
+import shutil
+from pathlib import Path
+
+import git
+
+from ..core.logger import Logger
+from .errors import GitCloneError
+
+_logger = Logger(__name__)
+
+
+async def clone_repository(
+ repo_url: str,
+ target: Path,
+ depth: int = 1,
+) -> None:
+ """
+ Clone a Git repository to the specified target directory.
+ """
+ loop = asyncio.get_event_loop()
+ await loop.run_in_executor(
+ None,
+ lambda: git.Repo.clone_from(
+ repo_url,
+ str(target),
+ depth=depth,
+ single_branch=True,
+ ),
+ )
+
+
+async def copy_directory(source: Path, target: Path) -> None:
+ """
+ Copy a directory and its contents to a new location.
+ """
+ if platform.system() == "Windows":
+ os.system(f'xcopy "{source}" "{target}" /E /I /H /Y')
+ else:
+ await asyncio.to_thread(
+ shutil.copytree,
+ source,
+ target,
+ dirs_exist_ok=True,
+ ignore=shutil.ignore_patterns(".git"),
+ )
+
+
+async def remove_directory(path: Path) -> None:
+ """
+ Remove a temporary directory and its contents.
+ """
+ if platform.system() == "Windows":
+ os.system(f'rmdir /S /Q "{path}"')
+ else:
+ await asyncio.to_thread(shutil.rmtree, path, ignore_errors=True)
+
+
+async def remove_hidden_contents(directory: Path) -> None:
+ """
+ Remove hidden files and directories from a specified directory.
+ """
+ for item in directory.iterdir():
+ if item.name.startswith(".") and item.name != ".github":
+ if item.is_dir():
+ shutil.rmtree(item)
+ else:
+ item.unlink()
+
+
+async def retrieve_repository(repository: Path | str, temp_dir: str) -> str:
+ """
+ Clone repository to temporary directory and return the path.
+ """
+ temp_dir_path = Path(temp_dir)
+ repo_path = Path(repository)
+
+ try:
+ if temp_dir_path.exists():
+ await remove_directory(temp_dir_path)
+
+ if repo_path.is_dir():
+ await copy_directory(repo_path, temp_dir_path)
+ else:
+ await clone_repository(str(repository), temp_dir_path)
+
+ await remove_hidden_contents(temp_dir_path)
+
+ return str(temp_dir_path)
+
+ except (
+ git.GitCommandError,
+ git.InvalidGitRepositoryError,
+ git.NoSuchPathError,
+ ) as exc:
+ _logger.error(f"Failed to clone repository {repository}: {exc}")
+ raise GitCloneError(
+ f"Failed to clone repository {repository}",
+ ) from exc
+
+ except Exception as exc:
+ _logger.error(
+ f"Unexpected error while cloning repository {repository}: {exc}",
+ )
+ raise GitCloneError(
+ f"Unexpected error while cloning repository {repository}",
+ ) from exc
diff --git a/readmeai/services/metadata.py b/readmeai/vcs/metadata.py
similarity index 79%
rename from readmeai/services/metadata.py
rename to readmeai/vcs/metadata.py
index 25fb03e5..24cafd2c 100644
--- a/readmeai/services/metadata.py
+++ b/readmeai/vcs/metadata.py
@@ -3,25 +3,27 @@
"""
from dataclasses import dataclass
-from typing import Any, Dict, List, Optional
+from typing import Any
import aiohttp
from readmeai.core.logger import Logger
-from readmeai.services.git import fetch_git_api_url
+from readmeai.vcs.url_builder import GitURL
_logger = Logger(__name__)
@dataclass
class RepositoryMetadata:
- """Dataclass to store GitHub repository metadata."""
+ """
+ Dataclass to store GitHub repository metadata.
+ """
name: str
full_name: str
owner: str
- owner_url: Optional[str]
- description: Optional[str]
+ owner_url: str | None
+ description: str | None
# Repository statistics
stars_count: int
@@ -39,29 +41,31 @@ class RepositoryMetadata:
# Repository URLs
clone_url_http: str
clone_url_ssh: str
- contributors_url: Optional[str]
+ contributors_url: str | None
languages_url: str
- issues_url: Optional[str]
+ issues_url: str | None
# Programming languages and topics
- language: Optional[str]
- languages: List[str]
- topics: List[str]
+ language: str | None
+ languages: list[str]
+ topics: list[str]
# Additional repository settings
has_wiki: bool
has_issues: bool
has_projects: bool
is_private: bool
- homepage_url: Optional[str]
+ homepage_url: str | None
# License information
- license_name: Optional[str]
- license_url: Optional[str]
+ license_name: str | None
+ license_url: str | None
def _parse_repository_metadata(repo_data: dict) -> RepositoryMetadata:
- """Converts raw repository data from GitHub API into dataclass."""
+ """
+ Converts raw repository data from GitHub API into dataclass.
+ """
languages = repo_data.get("languages", {})
license_info = repo_data.get("license", {}) or {}
owner_info = repo_data.get("owner", {}) or {}
@@ -100,9 +104,13 @@ def _parse_repository_metadata(repo_data: dict) -> RepositoryMetadata:
async def _fetch_repository_metadata(
- session: aiohttp.ClientSession, url: str, **kwargs
-) -> Dict[str, Any]:
- """Fetches repository metadata from the git host provider."""
+ session: aiohttp.ClientSession,
+ url: str,
+ **kwargs,
+) -> dict[str, Any]:
+ """
+ Fetches repository metadata from the git host provider.
+ """
async with session.get(url, **kwargs) as response:
response.raise_for_status()
if response.status != 200:
@@ -115,19 +123,22 @@ async def _fetch_repository_metadata(
async def fetch_git_repository_metadata(
- session: aiohttp.ClientSession, repository: str
-) -> Optional[RepositoryMetadata]:
- """Retrieves GitHub repository metadata and returns a dataclass."""
- api_url = await fetch_git_api_url(repository)
+ session: aiohttp.ClientSession,
+ repository: str,
+) -> RepositoryMetadata | None:
+ """
+ Retrieves GitHub repository metadata and returns a dataclass.
+ """
+ api_url = GitURL.create(repository).get_api_url()
+
if not api_url:
return None
try:
metadata = await _fetch_repository_metadata(session, api_url)
return _parse_repository_metadata(metadata) if metadata else None
-
except aiohttp.ClientError as exc:
_logger.error(
- f"Client error while fetching repository metadata: {exc}"
+ f"Client error while fetching repository metadata: {exc}",
)
return None
diff --git a/readmeai/vcs/providers.py b/readmeai/vcs/providers.py
new file mode 100644
index 00000000..11c7dc61
--- /dev/null
+++ b/readmeai/vcs/providers.py
@@ -0,0 +1,78 @@
+from enum import Enum
+from pathlib import Path
+
+from pydantic import HttpUrl
+
+from .errors import GitURLError
+
+
+class GitHost(Enum):
+ """
+ Enum for supported Git repository hosting services.
+ """
+
+ GITHUB = (
+ "github.com",
+ "https://api.github.com/repos/",
+ "https://github.com/{full_name}/blob/main/{file_path}",
+ )
+ GITLAB = (
+ "gitlab.com",
+ "https://gitlab.com/api/v4/projects/",
+ "https://gitlab.com/{full_name}/-/blob/main/{file_path}",
+ )
+ BITBUCKET = (
+ "bitbucket.org",
+ "https://api.bitbucket.org/2.0/repositories/",
+ "https://bitbucket.org/{full_name}/src/master/{file_path}",
+ )
+ LOCAL = ("local", "", "{file_path}")
+
+ def __init__(self, name: str, api_url: str, file_url_template: str):
+ """
+ Initialize git host domain, REST API URL, and file URL template.
+ """
+ self.domain = name
+ self.api_url = api_url
+ self.file_url_template = file_url_template
+
+
+def parse_git_url(url: str | Path) -> tuple[str, str, str, str]:
+ """
+ Parse Git repository URL and return host, full name, and project name.
+ """
+ if isinstance(url, Path) or (isinstance(url, str) and Path(url).is_dir()):
+ host_domain = host = GitHost.LOCAL.name
+ name = Path(url).name
+ full_name = f"{Path(url).parent.name}/{name}"
+ else:
+ try:
+ parsed_url = HttpUrl(url)
+ if parsed_url.scheme not in ["http", "https"]:
+ raise GitURLError(
+ url,
+ f"Uknown scheme provided: {parsed_url.scheme}",
+ )
+ except ValueError as e:
+ raise GitURLError(url) from e
+
+ assert (
+ parsed_url.host and parsed_url.path
+ ), f"Invalid Git repository URL: {parsed_url}"
+ path_parts = parsed_url.path.strip("/").split("/")
+ host_domain = parsed_url.host
+ host = parsed_url.host.split(".")[0].lower()
+ name = path_parts[-1]
+ full_name = "/".join(path_parts[:2])
+
+ return host_domain, host, name, full_name
+
+
+def get_file_url(host: GitHost, full_name: str, file_path: str) -> str:
+ """
+ Return the URL of the file in the remote repository.
+ """
+ return host.file_url_template.format(
+ full_name=full_name,
+ file_path=file_path,
+ )
diff --git a/readmeai/vcs/url_builder.py b/readmeai/vcs/url_builder.py
new file mode 100644
index 00000000..79a45217
--- /dev/null
+++ b/readmeai/vcs/url_builder.py
@@ -0,0 +1,92 @@
+import functools
+
+from pydantic import (
+ BaseModel,
+ Field,
+ HttpUrl,
+ field_validator,
+ model_validator,
+)
+
+from .providers import GitHost, get_file_url, parse_git_url
+
+
+class GitURL(BaseModel):
+ """
+ Git repository URL model with validation and parsing methods.
+ """
+
+ url: HttpUrl
+ host: GitHost | None = Field(default=None)
+ host_domain: str = Field(default="")
+ name: str = Field(default="")
+ full_name: str = Field(default="")
+
+ model_config = {
+ "frozen": True,
+ "use_enum_values": True,
+ "extra": "forbid",
+ "arbitrary_types_allowed": True,
+ }
+
+ @field_validator("url")
+ @classmethod
+ def validate_url(cls, v: HttpUrl) -> HttpUrl:
+ """
+ Validates the Git repository URL.
+ """
+ try:
+ parse_git_url(str(v))
+ except ValueError as e:
+ raise ValueError(f"Invalid Git repository URL: {v}") from e
+ return v
+
+ @model_validator(mode="after")
+ def set_attributes(self) -> "GitURL":
+ """
+ Sets the Git URL attributes based on the URL.
+ """
+ try:
+ host_domain, host, name, full_name = parse_git_url(str(self.url))
+ object.__setattr__(self, "host_domain", host_domain)
+ object.__setattr__(self, "name", name)
+ object.__setattr__(self, "full_name", full_name)
+ for git_host in GitHost:
+ if git_host.name.lower() == host:
+ object.__setattr__(self, "host", git_host)
+ break
+ except ValueError as e:
+ raise ValueError(f"Failed to parse Git URL: {self.url}") from e
+ return self
+
+ @classmethod
+ @functools.lru_cache(maxsize=100)
+ def create(cls, url: HttpUrl) -> "GitURL":
+ """
+ Create a GitURL object from a string URL.
+ """
+ return cls(url=url)
+
+ def get_api_url(self) -> str:
+ """
+ Return the REST API endpoint URL for a git repository.
+ """
+ # Ensure self.host is not None and self.host is not GitHost.LOCAL
+ if self.host is not None and self.host != GitHost.LOCAL:
+ # Ensure self.full_name is not None or empty
+ if self.full_name:
+ return f"{self.host.api_url}/{self.full_name}"
+ else:
+ raise ValueError("Repository full name is required.")
+ else:
+ raise ValueError(
+ f"Unsupported Git host or local repository: {self.url}",
+ )
+
+ def get_file_url(self, file_path: str) -> str:
+ """
+ Return the URL of the file in the remote repository.
+ """
+ if self.host:
+ return get_file_url(self.host, self.full_name, file_path)
+ raise ValueError(f"Unsupported Git host: {self.url}")
diff --git a/scripts/run_batch.sh b/scripts/run_batch.sh
index 98a6f903..37e77178 100755
--- a/scripts/run_batch.sh
+++ b/scripts/run_batch.sh
@@ -5,8 +5,8 @@
filenames=(
#"readme-litellm"
#"readme-fal-js"
- #gitmate-2
#gitlab
+ #bitbucket
"readme-local"
"readme-python"
"readme-streamlit"
@@ -18,14 +18,14 @@ filenames=(
"readme-java"
"readme-fastapi-redis"
"readme-mlops"
- "readme-vertexai"
+ "readme-gemini"
"readme-offline"
)
repositories=(
#"https://github.com/BerriAI/litellm"
#"https://github.com/fal-ai/fal-js"
- #https://gitlab.com/gitmate/open-source/gitmate-2
- #https://gitlab.com/bavarder/bavarder/
+ #https://gitlab.com/rohanrk/gitmate-2
+ #https://bitbucket.org/jwalton/opup
"/Users/k01101011/Documents/GitHub/pyflink-poc"
"https://github.com/eli64s/readme-ai"
"https://github.com/eli64s/readme-ai-streamlit"
@@ -51,7 +51,7 @@ for index in "${!repositories[@]}"; do
random_badge=${badge_styles[$RANDOM % ${#badge_styles[@]}]}
random_badge_color=${badge_color[$RANDOM % ${#badge_color[@]}]}
image_style=${image[$RANDOM % ${#image[@]}]}
- alignment=${align[$RANDOM % ${#align[@]}]}
+ align=${align[$RANDOM % ${#align[@]}]}
rand_choice=$((RANDOM % 2))
# cmd="python3 -m readmeai.cli.main --tree-depth 2 -o \"$filename\" -r \"$repo\""
@@ -59,7 +59,7 @@ for index in "${!repositories[@]}"; do
if [ $index -eq $((${#repositories[@]} - 2)) ]; then
cmd="python3 -m readmeai.cli.main --api vertex -o "$filename" -r "$repo""
- elif [ $index -eq $((${#repositories[@]} - 1)) ]; then
+ elif [ $index -eq $((${#repositories[@]} - 1)) ]; then
cmd="python3 -m readmeai.cli.main --api offline -o "$filename" -r "$repo""
else
cmd="python3 -m readmeai.cli.main --api openai --tree-depth 2 -o "$filename" -r "$repo""
@@ -71,8 +71,8 @@ for index in "${!repositories[@]}"; do
if [ "$image_style" != "blue" ]; then
cmd+=" -i \"$image_style\""
fi
- if [ "$alignment" != "center" ]; then
- cmd+=" -a \"$alignment\""
+ if [ "$align" != "center" ]; then
+ cmd+=" -a \"$align\""
fi
if [ $rand_choice -eq 1 ]; then
cmd+=" -e"
diff --git a/setup/requirements.txt b/setup/requirements.txt
index d1106fa1..646aaff7 100644
--- a/setup/requirements.txt
+++ b/setup/requirements.txt
@@ -1,47 +1,35 @@
-aiohttp==3.9.3 ; python_version >= "3.9" and python_version < "4.0"
+aiohttp==3.9.5 ; python_version >= "3.9" and python_version < "4.0"
aiosignal==1.3.1 ; python_version >= "3.9" and python_version < "4.0"
-anyio==4.3.0 ; python_version >= "3.9" and python_version < "4.0"
+annotated-types==0.7.0 ; python_version >= "3.9" and python_version < "4.0"
+anyio==4.4.0 ; python_version >= "3.9" and python_version < "4.0"
async-timeout==4.0.3 ; python_version >= "3.9" and python_version < "3.11"
attrs==23.2.0 ; python_version >= "3.9" and python_version < "4.0"
-cachetools==5.3.3 ; python_version >= "3.9" and python_version < "4.0"
-certifi==2024.2.2 ; python_version >= "3.9" and python_version < "4.0"
+certifi==2024.7.4 ; python_version >= "3.9" and python_version < "4.0"
charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "4.0"
click==8.1.7 ; python_version >= "3.9" and python_version < "4.0"
colorama==0.4.6 ; python_version >= "3.9" and python_version < "4.0" and platform_system == "Windows"
distro==1.9.0 ; python_version >= "3.9" and python_version < "4.0"
-exceptiongroup==1.2.0 ; python_version >= "3.9" and python_version < "3.11"
+exceptiongroup==1.2.1 ; python_version >= "3.9" and python_version < "3.11"
frozenlist==1.4.1 ; python_version >= "3.9" and python_version < "4.0"
gitdb==4.0.11 ; python_version >= "3.9" and python_version < "4.0"
-gitpython==3.1.42 ; python_version >= "3.9" and python_version < "4.0"
-google-ai-generativelanguage==0.4.0 ; python_version >= "3.9" and python_version < "4.0"
-google-api-core==2.17.1 ; python_version >= "3.9" and python_version < "4.0"
-google-api-core[grpc]==2.17.1 ; python_version >= "3.9" and python_version < "4.0"
-google-auth==2.28.2 ; python_version >= "3.9" and python_version < "4.0"
-google-generativeai==0.4.0 ; python_version >= "3.9" and python_version < "4.0"
-googleapis-common-protos==1.62.0 ; python_version >= "3.9" and python_version < "4.0"
-grpcio-status==1.62.1 ; python_version >= "3.9" and python_version < "4.0"
-grpcio==1.62.1 ; python_version >= "3.9" and python_version < "4.0"
+gitpython==3.1.43 ; python_version >= "3.9" and python_version < "4.0"
h11==0.14.0 ; python_version >= "3.9" and python_version < "4.0"
-httpcore==1.0.4 ; python_version >= "3.9" and python_version < "4.0"
+httpcore==1.0.5 ; python_version >= "3.9" and python_version < "4.0"
httpx==0.27.0 ; python_version >= "3.9" and python_version < "4.0"
-idna==3.6 ; python_version >= "3.9" and python_version < "4.0"
+idna==3.7 ; python_version >= "3.9" and python_version < "4.0"
multidict==6.0.5 ; python_version >= "3.9" and python_version < "4.0"
-openai==1.13.3 ; python_version >= "3.9" and python_version < "4.0"
-proto-plus==1.23.0 ; python_version >= "3.9" and python_version < "4.0"
-protobuf==4.25.3 ; python_version >= "3.9" and python_version < "4.0"
-pyasn1-modules==0.3.0 ; python_version >= "3.9" and python_version < "4.0"
-pyasn1==0.5.1 ; python_version >= "3.9" and python_version < "4.0"
-pydantic==1.10.14 ; python_version >= "3.9" and python_version < "4.0"
+openai==1.35.10 ; python_version >= "3.9" and python_version < "4.0"
+pydantic-core==2.20.1 ; python_version >= "3.9" and python_version < "4.0"
+pydantic-extra-types==2.9.0 ; python_version >= "3.9" and python_version < "4.0"
+pydantic==2.8.2 ; python_version >= "3.9" and python_version < "4.0"
pyyaml==6.0.1 ; python_version >= "3.9" and python_version < "4.0"
-regex==2023.12.25 ; python_version >= "3.9" and python_version < "4.0"
-requests==2.31.0 ; python_version >= "3.9" and python_version < "4.0"
-rsa==4.9 ; python_version >= "3.9" and python_version < "4"
+regex==2024.5.15 ; python_version >= "3.9" and python_version < "4.0"
+requests==2.32.3 ; python_version >= "3.9" and python_version < "4.0"
smmap==5.0.1 ; python_version >= "3.9" and python_version < "4.0"
sniffio==1.3.1 ; python_version >= "3.9" and python_version < "4.0"
-tenacity==8.2.3 ; python_version >= "3.9" and python_version < "4.0"
+tenacity==8.5.0 ; python_version >= "3.9" and python_version < "4.0"
tiktoken==0.4.0 ; python_version >= "3.9" and python_version < "4.0"
-toml==0.10.2 ; python_version >= "3.9" and python_version < "3.11"
-tqdm==4.66.2 ; python_version >= "3.9" and python_version < "4.0"
-typing-extensions==4.10.0 ; python_version >= "3.9" and python_version < "4.0"
-urllib3==2.2.1 ; python_version >= "3.9" and python_version < "4.0"
+tqdm==4.66.4 ; python_version >= "3.9" and python_version < "4.0"
+typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "4.0"
+urllib3==2.2.2 ; python_version >= "3.9" and python_version < "4.0"
yarl==1.9.4 ; python_version >= "3.9" and python_version < "4.0"
diff --git a/tests/cli/test_main.py b/tests/cli/test_main.py
index 17f1486c..62de8847 100644
--- a/tests/cli/test_main.py
+++ b/tests/cli/test_main.py
@@ -16,7 +16,7 @@ def runner():
return CliRunner()
-@patch("readmeai._agent.clone_repository")
+@patch("readmeai.__main__.retrieve_repository")
def test_commands_with_defaults(mock_clone, runner, temp_dir, tmp_path):
"""Test the commands function with default options."""
mock_clone.return_value = temp_dir / "repo-dir"
@@ -24,15 +24,11 @@ def test_commands_with_defaults(mock_clone, runner, temp_dir, tmp_path):
main,
[
"--repository",
- temp_dir,
- "--api",
- "OFFLINE",
- "--alignment",
+ "https://github.com/eli64s/readme-ai-streamlit",
+ "--align",
"left",
- "--badge-style",
- "flat-square",
- "--output",
- tmp_path / "test_readme.md",
+ "--api",
+ "offline",
],
)
assert result.exit_code == 0
@@ -43,7 +39,7 @@ def test_commands_with_invalid_option(runner):
result = runner.invoke(
main,
[
- "--alignment",
+ "--align",
"right",
"--repository",
None,
diff --git a/tests/cli/test_options.py b/tests/cli/test_options.py
index d09f55e5..2ff54f48 100644
--- a/tests/cli/test_options.py
+++ b/tests/cli/test_options.py
@@ -17,7 +17,7 @@ def test_badge_options():
def test_image_options():
"""Test the CLI options for header images."""
- assert ImageOptions.CUSTOM.value == "custom"
- assert ImageOptions.LLM.value == "llm"
+ assert ImageOptions.CUSTOM.value == "CUSTOM"
+ assert ImageOptions.LLM.value == "LLM"
assert isinstance(ImageOptions.BLUE, str)
assert isinstance(ImageOptions.BLACK, str)
diff --git a/tests/config/test_validators.py b/tests/config/test_validators.py
deleted file mode 100644
index a96194c4..00000000
--- a/tests/config/test_validators.py
+++ /dev/null
@@ -1,132 +0,0 @@
-"""
-Tests for validator methods used on command-line arguments.
-"""
-
-from pathlib import Path
-from unittest.mock import patch
-
-import pytest
-
-from readmeai._exceptions import GitValidationError
-from readmeai.config.validators import GitValidator
-from readmeai.services.git import GitHost
-
-
-@pytest.mark.parametrize(
- "url",
- [
- "https://github.com/user/repo",
- "https://gitlab.com/user/repo",
- "https://bitbucket.org/user/repo",
- ],
-)
-def test_validate_repository_with_valid_git_url(url):
- """Test validating a valid git URL."""
- assert GitValidator.validate_repository(url) == url
-
-
-def test_validate_repository_with_valid_directory(tmp_path: Path):
- """Test validating a valid directory."""
- assert isinstance(GitValidator.validate_repository(tmp_path), Path)
-
-
-def test_validate_repository_with_invalid_url():
- """Test validating an invalid git URL."""
- with pytest.raises(GitValidationError):
- GitValidator.validate_repository("https://invalidurl.com/user/repo")
-
-
-def test_validate_repository_with_invalid_string():
- """Test validating an invalid string."""
- with pytest.raises(GitValidationError):
- GitValidator.validate_repository("not_a_url_or_directory")
-
-
-def test_validate_repository_with_non_directory_path(tmp_path: Path):
- """Test validating a non-directory path."""
- non_dir_path = tmp_path / "file.txt"
- non_dir_path.touch()
- with pytest.raises(GitValidationError):
- GitValidator.validate_repository(non_dir_path)
-
-
-def test_validate_repository_with_exception_during_parsing():
- """Test validating a URL that raises an exception during parsing."""
- with patch("readmeai.config.validators.urlparse") as mock_urlparse:
- mock_urlparse.side_effect = Exception("Parsing error")
- with pytest.raises(GitValidationError):
- GitValidator.validate_repository("https://github.com/user/repo")
-
-
-@pytest.mark.parametrize(
- "url,expected_full_name",
- [
- ("https://github.com/user/repo", "user/repo"),
- ("https://gitlab.com/user/repo", "user/repo"),
- ("https://bitbucket.org/user/repo", "user/repo"),
- ],
-)
-def test_validate_full_name_with_valid_git_url(url, expected_full_name):
- """Test validating a valid git URL."""
- values = {"repository": url}
- assert (
- GitValidator.validate_full_name(None, values)
- == expected_full_name.lower()
- )
-
-
-def test_validate_full_name_with_valid_directory(tmp_path: Path):
- """Test validating a valid directory."""
- repo_path = tmp_path / "repo"
- repo_path.mkdir()
- values = {"repository": repo_path}
- assert GitValidator.validate_full_name(None, values) == "repo"
-
-
-def test_validate_full_name_with_invalid_url():
- """Test validating an invalid git URL."""
- values = {"repository": "https://invalidurl.com/user/repo"}
- with pytest.raises(GitValidationError):
- GitValidator.validate_full_name(None, values)
-
-
-def test_validate_full_name_with_non_existing_path():
- """Test validating a non-existing path."""
- values = {"repository": "/non/existing/path"}
- with pytest.raises(GitValidationError):
- GitValidator.validate_full_name(None, values)
-
-
-@pytest.mark.parametrize(
- "url, expected_service",
- [
- ("https://github.com/user/repo", "github"),
- ("https://gitlab.com/user/repo", "gitlab.com"),
- ("https://bitbucket.org/user/repo", "bitbucket.org"),
- ],
-)
-def test_set_host_with_valid_git_url(url, expected_service):
- """Test setting the host with a valid git URL."""
- values = {
- "repository": url,
- "host_domain": expected_service,
- }
- assert (
- GitValidator.set_host(None, values) == expected_service.split(".")[0]
- )
-
-
-def test_set_host_with_local_directory(tmp_path: Path):
- """Test setting the host with a local directory."""
- values = {"repository": tmp_path}
- assert GitValidator.set_host(None, values) == GitHost.LOCAL.name.lower()
-
-
-@pytest.mark.skip
-def test_set_host_with_invalid_url():
- """Test setting the host with an invalid git URL."""
- values = {
- "repository": "https://invalidurl.com/user/repo",
- "host_domain": "invalidurl.com",
- }
- assert GitValidator.set_host(None, values) == GitHost.LOCAL.name
diff --git a/tests/conftest.py b/tests/conftest.py
index 10273722..5de3fcfb 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -156,3 +156,10 @@ def mock_file_data():
dependencies=[],
),
]
+
+
+# Local host fixtures
+@pytest.fixture(scope="session")
+def ollama_localhost():
+ """Returns the default local host path."""
+ return "http://localhost:11434/"
diff --git a/tests/core/test_models.py b/tests/core/test_models.py
index abc8a779..480daa2c 100644
--- a/tests/core/test_models.py
+++ b/tests/core/test_models.py
@@ -19,7 +19,9 @@
],
)
async def test_openai_make_request(
- openai_handler, input_context, expected_call_count
+ openai_handler,
+ input_context,
+ expected_call_count,
):
"""Test that the OpenAI handler handles a response."""
# Arrange
@@ -53,18 +55,22 @@ async def test_openai_make_request_with_context(openai_handler):
# Arrange
openai_handler.http_client = MagicMock()
with patch.object(
- OpenAIHandler, "_make_request", new_callable=AsyncMock
+ OpenAIHandler,
+ "_make_request",
+ new_callable=AsyncMock,
) as mock_make_request:
# Act
await openai_handler._make_request("test_context", "test_prompt")
# Assert
mock_make_request.assert_called_once_with(
- "test_context", "test_prompt"
+ "test_context",
+ "test_prompt",
)
openai_handler.http_client.post.assert_not_called()
mock_make_request.assert_called_once_with(
- "test_context", "test_prompt"
+ "test_context",
+ "test_prompt",
)
@@ -74,24 +80,30 @@ async def test_openai_make_request_without_context(openai_handler):
# Arrange
openai_handler.http_client = MagicMock()
with patch.object(
- OpenAIHandler, "_make_request", new_callable=AsyncMock
+ OpenAIHandler,
+ "_make_request",
+ new_callable=AsyncMock,
) as mock_make_request:
# Act
await openai_handler._make_request("test_context", "test_prompt")
# Assert
mock_make_request.assert_called_once_with(
- "test_context", "test_prompt"
+ "test_context",
+ "test_prompt",
)
openai_handler.http_client.post.assert_not_called()
mock_make_request.assert_called_once_with(
- "test_context", "test_prompt"
+ "test_context",
+ "test_prompt",
)
@pytest.mark.asyncio
async def test_batch_request(
- openai_handler, mock_dependencies, mock_summaries
+ openai_handler,
+ mock_dependencies,
+ mock_summaries,
):
"""Test the handling of the response from the OpenAI API."""
# Arrange
@@ -99,7 +111,8 @@ async def test_batch_request(
openai_handler._make_request = AsyncMock()
# Act
test_response = await openai_handler.batch_request(
- mock_dependencies, mock_summaries
+ mock_dependencies,
+ mock_summaries,
)
# Assert
assert isinstance(test_response, list)
@@ -135,7 +148,10 @@ async def test_make_request_code_summary(openai_handler, mock_file_data):
openai_handler._make_request_code_summary = AsyncMock()
# Act
await openai_handler._make_request_code_summary(
- "file_summary", "test_prompt", 100, mock_file_data
+ "file_summary",
+ "test_prompt",
+ 100,
+ mock_file_data,
)
# Assert
openai_handler._make_request_code_summary.assert_called_once()
diff --git a/tests/core/test_preprocess.py b/tests/core/test_preprocess.py
index 18121c77..3b8287e2 100644
--- a/tests/core/test_preprocess.py
+++ b/tests/core/test_preprocess.py
@@ -19,7 +19,8 @@ def test_generate_contents(repo_processor, tmp_path):
(tmp_path / "file2.py").touch()
(tmp_path / "file3.py").touch()
(tmp_path / ".github" / "workflows" / "workflow.yml").mkdir(
- parents=True, exist_ok=True
+ parents=True,
+ exist_ok=True,
)
(tmp_path / "ignore.md").touch()
with patch(
@@ -27,7 +28,7 @@ def test_generate_contents(repo_processor, tmp_path):
return_value=False,
):
result = list(repo_processor.generate_contents(tmp_path))
- assert len(result) == 6
+ assert isinstance(result, list)
assert any(fd.file_name == "file1.py" for fd in result)
@@ -38,7 +39,8 @@ def test_generate_file_info(repo_processor, tmp_path):
(tmp_path / "file3.py").touch()
(tmp_path / "javascript.js").touch()
(tmp_path / ".github" / "workflows" / "workflow.yml").mkdir(
- parents=True, exist_ok=True
+ parents=True,
+ exist_ok=True,
)
with patch(
"readmeai.core.preprocess.RepositoryProcessor._filter_file",
@@ -46,7 +48,7 @@ def test_generate_file_info(repo_processor, tmp_path):
):
result = list(repo_processor.generate_file_info(tmp_path))
- assert len(result) == 6
+ assert isinstance(result, list)
assert any(fd.file_name == "file1.py" for fd in result)
@@ -77,7 +79,8 @@ def test_extract_dependencies(repo_processor):
mock_parser = MagicMock()
mock_parser.parse.return_value = ["flask==1.1.4"]
with patch(
- "readmeai.parsers.factory.parser_handler", return_value=mock_parser
+ "readmeai.parsers.factory.parser_handler",
+ return_value=mock_parser,
):
result = repo_processor.extract_dependencies(file_data)
assert "flask" in result
@@ -87,19 +90,18 @@ def test_get_dependencies(mock_file_data, mock_configs):
"""Test the get_dependencies method."""
processor = RepositoryProcessor(mock_configs)
dependencies = processor.get_dependencies(mock_file_data)
- assert isinstance(dependencies, tuple)
- assert len(dependencies) == 2
- assert "dependency1" in dependencies[0]
+ assert isinstance(dependencies, list)
+ assert "py" in dependencies
def test_get_dependencies_exception_handling(mock_file_data, mock_configs):
"""Test the get_dependencies method."""
processor = RepositoryProcessor(mock_configs)
processor.extract_dependencies = MagicMock(
- side_effect=Exception("Test exception")
+ side_effect=Exception("Test exception"),
)
dependencies = processor.get_dependencies(mock_file_data)
- assert isinstance(dependencies, tuple)
+ assert isinstance(dependencies, list)
@pytest.mark.parametrize(
diff --git a/tests/core/test_utils.py b/tests/core/test_utils.py
index ca86970c..111fa7a8 100644
--- a/tests/core/test_utils.py
+++ b/tests/core/test_utils.py
@@ -17,12 +17,14 @@ def test_get_environment_openai(mock_configs):
mock_configs.config.llm.api = ModelOptions.OPENAI.name
mock_configs.config.llm.model = "gpt-3.5-turbo"
test_api, test_model = get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert test_api == ModelOptions.OPENAI.name
assert test_model == "gpt-3.5-turbo"
+@pytest.mark.skip
@patch.dict(
"os.environ",
{"GOOGLE_API_KEY": "sk-google-key"},
@@ -33,7 +35,8 @@ def test_get_environment_gemini(mock_configs):
mock_configs.config.llm.api = ModelOptions.GEMINI.name
mock_configs.config.llm.model = "gemini-pro"
test_api, test_model = get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert test_api == ModelOptions.GEMINI.name
assert test_model == "gemini-pro"
@@ -45,7 +48,8 @@ def test_offline_mode_when_no_env_vars_set(mock_configs):
mock_configs.config.llm.api = None
mock_configs.config.llm.model = None
test_api, test_model = get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert test_api == ModelOptions.OFFLINE.name
assert test_model == ModelOptions.OFFLINE.name
@@ -56,7 +60,8 @@ def test_set_offline_mode(mock_configs):
"""Test that the environment is setup correctly for offline mode."""
mock_configs.config.llm.api = ModelOptions.OFFLINE.name
test_api, test_model = get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert test_api == ModelOptions.OFFLINE.name
assert test_model == ModelOptions.OFFLINE.name
@@ -67,7 +72,8 @@ def test_incorrect_api_service_sets_offline_mode(mock_configs):
mock_configs.config.llm.api = "incorrect-api"
with pytest.raises(Exception) as exc:
get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert isinstance(exc.value, UnsupportedServiceError)
@@ -78,12 +84,14 @@ def test_no_api_specified_but_openai_settings_exist_in_env(mock_configs):
mock_configs.config.llm.api = None
mock_configs.config.llm.model = None
test_api, test_model = get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert test_api == ModelOptions.OPENAI.name
assert test_model == "gpt-3.5-turbo"
+@pytest.mark.skip
@patch.dict(
"os.environ",
{"GOOGLE_API_KEY": "sk-google-key"},
@@ -94,7 +102,8 @@ def test_no_api_specified_but_gemini_settings_exist_in_env(mock_configs):
mock_configs.config.llm.api = None
mock_configs.config.llm.model = None
test_api, test_model = get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert test_api == ModelOptions.GEMINI.name
assert test_model == "gemini-pro"
@@ -105,18 +114,21 @@ def test_missing_openai_settings_so_set_offline_mode(mock_configs):
"""Test that the environment variables are scanned correctly."""
mock_configs.config.llm.api = ModelOptions.OPENAI.name
test_api, test_model = get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert test_api == ModelOptions.OFFLINE.name
assert test_model == ModelOptions.OFFLINE.name
+@pytest.mark.skip
@patch.dict("os.environ", {}, clear=True)
def test_missing_gemini_settings_so_set_offline_mode(mock_configs):
"""Test that the environment variables are scanned correctly."""
mock_configs.config.llm.api = ModelOptions.GEMINI.name
test_api, test_model = get_environment(
- mock_configs.config.llm.api, mock_configs.config.llm.model
+ mock_configs.config.llm.api,
+ mock_configs.config.llm.model,
)
assert test_api == ModelOptions.OFFLINE.name
assert test_model == ModelOptions.OFFLINE.name
diff --git a/tests/generators/test_badges.py b/tests/generators/test_badges.py
index 1c84cf84..9450484e 100644
--- a/tests/generators/test_badges.py
+++ b/tests/generators/test_badges.py
@@ -6,7 +6,7 @@
_format_badges,
build_default_badges,
build_project_badges,
- shields_icons,
+ shieldsio_icons,
skill_icons,
)
@@ -17,7 +17,7 @@
([], ""),
(
[
- "https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white"
+ "https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white",
],
'
\n',
),
@@ -59,11 +59,14 @@ def test_build_default_badges_success(mock_config):
assert "license" in badges
-def test_shields_icons_success(mock_config, mock_dependencies):
- """Tests shields_icons with valid inputs."""
+def test_shieldsio_icons_success(mock_config, mock_dependencies):
+ """Tests shieldsio_icons with valid inputs."""
mock_config.md.badge_style = "flat"
- badges = shields_icons(
- mock_config, mock_dependencies, "github.com", "user/repo"
+ badges = shieldsio_icons(
+ mock_config,
+ mock_dependencies,
+ "github.com",
+ "user/repo",
)
assert isinstance(badges, tuple)
assert any("style=flat" in badge for badge in badges)
diff --git a/tests/generators/test_builder.py b/tests/generators/test_builder.py
index 2d30a24e..ea7bfc6c 100644
--- a/tests/generators/test_builder.py
+++ b/tests/generators/test_builder.py
@@ -2,17 +2,20 @@
Tests for the README.md builder module in the generators package.
"""
+from pathlib import Path
+
import pytest
+from readmeai.config.settings import ConfigLoader
from readmeai.generators.builder import MarkdownBuilder
@pytest.fixture
def readme_builder(
- mock_configs,
- mock_dependencies,
- mock_summaries,
- tmp_path,
+ mock_configs: ConfigLoader,
+ mock_dependencies: list[str],
+ mock_summaries: list[tuple[str, str]],
+ tmp_path: Path,
):
return MarkdownBuilder(
mock_configs,
@@ -22,35 +25,35 @@ def readme_builder(
)
-def test_md_header(readme_builder):
+def test_md_header(readme_builder: MarkdownBuilder):
"""Tests if md_header property returns a string."""
header = readme_builder.md_header
assert isinstance(header, str)
-def test_md_summaries(readme_builder):
+def test_md_summaries(readme_builder: MarkdownBuilder):
"""Tests if md_summaries property returns a string."""
summaries = readme_builder.md_summaries
assert isinstance(summaries, str)
-def test_md_tree(readme_builder):
+def test_md_tree(readme_builder: MarkdownBuilder):
"""Tests if md_tree property returns a string."""
tree = readme_builder.md_tree
assert isinstance(tree, str)
-def test_md_quickstart(readme_builder):
+def test_md_quickstart(readme_builder: MarkdownBuilder):
"""Tests if md_quick_start property returns a string."""
quickstart = readme_builder.md_quickstart
assert isinstance(quickstart, str)
def test_build(
- mock_configs,
- mock_dependencies,
- mock_summaries,
- tmp_path,
+ mock_configs: ConfigLoader,
+ mock_dependencies: list[str],
+ mock_summaries: tuple,
+ tmp_path: str,
):
"""Tests the build_markdown function."""
md_contents = MarkdownBuilder(
diff --git a/tests/generators/test_tables.py b/tests/generators/test_tables.py
index 36fcf6b3..4caf6a30 100644
--- a/tests/generators/test_tables.py
+++ b/tests/generators/test_tables.py
@@ -4,6 +4,8 @@
from unittest.mock import patch
+import pytest
+
from readmeai.generators.tables import (
construct_markdown_table,
extract_folder_name,
@@ -13,19 +15,150 @@
group_summaries_by_folder,
is_valid_tuple_summary,
)
-from readmeai.services.git import fetch_git_file_url
-
-
-def test_construct_markdown_table(mock_config):
- """Test that the construct_markdown_table function constructs the table."""
- data = [("module1.py", "Summary 1")]
- repo_url = str(mock_config.git.repository)
- full_name = mock_config.git.full_name
- expected_link = fetch_git_file_url(repo_url, full_name, "module1.py")
- table = construct_markdown_table(data, repo_url, full_name)
- assert expected_link in f"[module1.py]({expected_link})"
- assert "module1.py" in table
- assert "Summary 1" in table
+
+mock_data = [
+ ("file1.py", "Summary 1"),
+ ("dir/file2.py", "Summary 2"),
+ ("file3.py", "Summary 3"),
+]
+
+
+@pytest.fixture
+def mock_logger():
+ with patch("readmeai.generators.tables._logger") as mock:
+ yield mock
+
+
+def test_construct_markdown_table_local_repo(mock_logger):
+ with patch("pathlib.Path.exists", return_value=True):
+ result = construct_markdown_table(
+ mock_data,
+ "/local/repo",
+ "local_repo",
+ )
+
+ assert "| File | Summary |" in result
+ assert "| [file1.py](/local/repo/file1.py) | Summary 1 |" in result
+ assert "| [file2.py](/local/repo/dir/file2.py) | Summary 2 |" in result
+ assert "| [file3.py](/local/repo/file3.py) | Summary 3 |" in result
+
+
+def test_construct_markdown_table_remote_repo(mock_logger):
+ with (
+ patch("pathlib.Path.exists", return_value=False),
+ patch("readmeai.generators.tables.GitURL") as mock_git_url,
+ ):
+ mock_git_url.create.return_value.get_file_url.side_effect = [
+ "https://github.com/owner/repo/blob/main/file1.py",
+ "https://github.com/owner/repo/blob/main/dir/file2.py",
+ "https://github.com/owner/repo/blob/main/file3.py",
+ ]
+ result = construct_markdown_table(
+ mock_data,
+ "https://github.com/owner/repo.git",
+ "owner/repo",
+ )
+
+ assert "| File | Summary |" in result
+ assert (
+ "| [file1.py](https://github.com/owner/repo/blob/main/file1.py) | Summary 1 |"
+ in result
+ )
+ assert (
+ "| [file2.py](https://github.com/owner/repo/blob/main/dir/file2.py) | Summary 2 |"
+ in result
+ )
+ assert (
+ "| [file3.py](https://github.com/owner/repo/blob/main/file3.py) | Summary 3 |"
+ in result
+ )
+
+
+def test_construct_markdown_table_max_rows(mock_logger):
+ result = construct_markdown_table(
+ mock_data,
+ "/local/repo",
+ "local_repo",
+ max_rows=2,
+ )
+
+ assert "| File | Summary |" in result
+ assert "| [file1.py](/local/repo/file1.py) | Summary 1 |" in result
+ assert "| [file2.py](/local/repo/dir/file2.py) | Summary 2 |" in result
+ assert "| ... | ... |" in result
+ assert "| [file3.py](/local/repo/file3.py) | Summary 3 |" not in result
+ mock_logger.warning.assert_called_once()
+
+
+def test_construct_markdown_table_empty_data(mock_logger):
+ result = construct_markdown_table([], "/local/repo", "local_repo")
+
+ assert result == ""
+ mock_logger.warning.assert_called_once()
+
+
+def test_construct_markdown_table_invalid_git_url(mock_logger):
+ with (
+ patch("pathlib.Path.exists", return_value=False),
+ patch("readmeai.generators.tables.GitURL") as mock_git_url,
+ ):
+ mock_git_url.create.side_effect = ValueError("Invalid Git URL")
+ result = construct_markdown_table(
+ mock_data,
+ "invalid_url",
+ "owner/repo",
+ )
+
+ assert "| File | Summary |" in result
+ mock_logger.error.assert_called_once()
+
+
+def test_construct_markdown_table_git_url_file_error(mock_logger):
+ with (
+ patch("pathlib.Path.exists", return_value=False),
+ patch("readmeai.generators.tables.GitURL") as mock_git_url,
+ ):
+ mock_git_url.create.return_value.get_file_url.side_effect = [
+ "https://github.com/owner/repo/blob/main/file1.py",
+ ValueError("Invalid file path"),
+ "https://github.com/owner/repo/blob/main/file3.py",
+ ]
+ result = construct_markdown_table(
+ mock_data,
+ "https://github.com/owner/repo.git",
+ "owner/repo",
+ )
+
+ assert "| File | Summary |" in result
+ assert (
+ "| [file1.py](https://github.com/owner/repo/blob/main/file1.py) | Summary 1 |"
+ in result
+ )
+ assert "| file2.py | Summary 2 |" in result
+ assert (
+ "| [file3.py](https://github.com/owner/repo/blob/main/file3.py) | Summary 3 |"
+ in result
+ )
+ mock_logger.error.assert_called_once()
+
+
+@pytest.mark.parametrize(
+ "invalid_input",
+ [
+ ("not a list", "/local/repo", "local_repo"),
+ (
+ [("file1.py", "Summary 1"), "not a tuple"],
+ "/local/repo",
+ "local_repo",
+ ),
+ (mock_data, 12345, "local_repo"),
+ (mock_data, "/local/repo", 12345),
+ (mock_data, "/local/repo", "local_repo", "not an int"),
+ ],
+)
+def test_construct_markdown_table_invalid_input(invalid_input):
+ with pytest.raises(AssertionError):
+ construct_markdown_table(*invalid_input)
def test_extract_folder_name():
diff --git a/tests/models/test_dalle.py b/tests/models/test_dalle.py
index 3679aaf3..82c3e8d3 100644
--- a/tests/models/test_dalle.py
+++ b/tests/models/test_dalle.py
@@ -13,7 +13,7 @@
def cleanup_mock_png_files(directory="."):
"""Cleanup mock png files."""
pattern = re.compile(
- r"
\.png"
+ r"\.png",
)
for filename in Path(directory).glob("*.png"):
if pattern.match(filename.name):
@@ -28,12 +28,12 @@ def test_image_generator(mock_client):
config = MagicMock()
image_generator = DalleHandler(config)
image_generator._build_prompt = MagicMock(return_value="prompt")
- image_generator.client.images.run = MagicMock(
- return_value=MagicMock(data=[MagicMock(url="url")])
+ image_generator.client.images._make_request = MagicMock(
+ return_value=MagicMock(data=[MagicMock(url="url")]),
)
# When
- result = image_generator.run()
+ result = image_generator._make_request()
# Then
assert result is not None
@@ -88,7 +88,7 @@ def test_image_download_failure(mock_get):
with patch("builtins.open", MagicMock()) as mock_open:
assert result == ImageOptions.BLUE.value
image_generator._logger.error.assert_called_once_with(
- "Failed to download image: 404"
+ "Failed to download image: 404",
)
mock_open.assert_not_called()
mock_response.content = b"image"
diff --git a/tests/models/test_factory.py b/tests/models/test_factory.py
index e9baa9a6..307ce1ad 100644
--- a/tests/models/test_factory.py
+++ b/tests/models/test_factory.py
@@ -5,7 +5,7 @@
import pytest
from readmeai._exceptions import UnsupportedServiceError
-from readmeai.models.factory import ModelFactory
+from readmeai.models.factory import ModelRegistry
from readmeai.models.gemini import GeminiHandler
from readmeai.models.offline import OfflineHandler
from readmeai.models.openai import OpenAIHandler
@@ -31,6 +31,6 @@ def test_model_handler_unsupported_service(mock_config, mock_configs):
mock_config.llm.api = "OpenAGI"
mock_config.llm.model = "agi-turbo-3000"
with pytest.raises(Exception) as exc:
- ModelFactory.model_handler(mock_config, mock_configs)
+ ModelRegistry.get_backend(mock_config, mock_configs)
assert isinstance(exc.value, UnsupportedServiceError)
assert str(exc.value) == "Unsupported service: OpenAGI"
diff --git a/tests/models/test_gemini.py b/tests/models/test_gemini.py
index 515a0b6a..824d773c 100644
--- a/tests/models/test_gemini.py
+++ b/tests/models/test_gemini.py
@@ -25,7 +25,9 @@ async def test_gemini_make_request_with_context(gemini_handler):
handler.http_client = MagicMock()
# Act
with patch.object(
- GeminiHandler, "_make_request", new_callable=AsyncMock
+ GeminiHandler,
+ "_make_request",
+ new_callable=AsyncMock,
) as mock_make_request:
# Act
await handler._make_request()
@@ -36,21 +38,20 @@ async def test_gemini_make_request_with_context(gemini_handler):
@pytest.mark.asyncio
-async def test_make_request_success(mock_config, mock_configs):
- """Test that the Gemini API handler handles a successful response."""
- mock_config.llm.context_window = 100
- mock_response = MagicMock()
- mock_response.text = "Generated text"
- mock_model = MagicMock()
- mock_model.generate_content_async = AsyncMock(return_value=mock_response)
-
- with patch(
- "readmeai.models.gemini.genai.GenerativeModel", return_value=mock_model
- ):
- handler = GeminiHandler(mock_configs)
- response_index, response_text = await handler._make_request(
- "test_index", "test_prompt", 100
- )
-
- assert response_index == "test_index"
- assert response_text == "Generated text"
+async def test_gemini_make_request_without_context(gemini_handler):
+ """Test that the Gemini API handler handles a response without context."""
+ # Arrange
+ handler = gemini_handler
+ handler.http_client = MagicMock()
+ # Act
+ with patch.object(
+ GeminiHandler,
+ "_make_request",
+ new_callable=AsyncMock,
+ ) as mock_make_request:
+ # Act
+ await handler._make_request()
+ # Assert
+ mock_make_request.assert_called_once_with()
+ handler.http_client.post.assert_not_called()
+ mock_make_request.assert_called_once_with()
diff --git a/tests/models/test_openai.py b/tests/models/test_openai.py
index e7780a61..909bdfbc 100644
--- a/tests/models/test_openai.py
+++ b/tests/models/test_openai.py
@@ -5,21 +5,11 @@
from unittest.mock import AsyncMock, MagicMock, patch
import aiohttp
+import openai
import pytest
from readmeai.cli.options import ModelOptions as llms
-_localhost = "http://localhost:11434/v1/"
-
-
-@pytest.mark.asyncio
-async def test_openai_endpoint_configuration_for_openai(
- mock_configs, openai_handler
-):
- """Test that the correct endpoint is set for OpenAI API."""
- mock_configs.config.llm.api = llms.OPENAI.name
- assert openai_handler.endpoint == mock_configs.config.llm.base_url
-
@pytest.mark.asyncio
async def test_openai_handler_sets_attributes(openai_handler):
@@ -30,14 +20,31 @@ async def test_openai_handler_sets_attributes(openai_handler):
assert hasattr(openai_handler, "top_p")
-@pytest.mark.skip
+@pytest.mark.asyncio
+async def test_openai_endpoint_configuration_for_openai(
+ mock_configs,
+ openai_handler,
+):
+ """Test that the correct endpoint is set for OpenAI API."""
+ mock_configs.config.llm.api = llms.OPENAI.name
+ assert (
+ openai_handler.url
+ == f"{mock_configs.config.llm.host_name}{mock_configs.config.llm.path}"
+ )
+
+
@pytest.mark.asyncio
async def test_openai_endpoint_configuration_for_ollama(
- mock_configs, openai_handler
+ mock_configs,
+ ollama_localhost,
):
"""Test that the correct endpoint is set for OLLAMA."""
mock_configs.config.llm.api = llms.OLLAMA.name
- assert openai_handler.endpoint == f"{_localhost}chat/completions"
+ mock_configs.config.llm.localhost = ollama_localhost
+ assert (
+ "v1/chat/completions"
+ in f"{mock_configs.config.llm.localhost}{mock_configs.config.llm.path}"
+ )
@pytest.mark.asyncio
@@ -62,16 +69,19 @@ async def test_make_request_success(mock_post, openai_handler):
mock_response = AsyncMock(
json=AsyncMock(
return_value={
- "choices": [{"message": {"content": "test_response"}}]
- }
- )
+ "choices": [{"message": {"content": "test_response"}}],
+ },
+ ),
)
mock_response_cm.__aenter__.return_value = mock_response
mock_post.return_value = mock_response_cm
openai_handler._session = MagicMock(spec=aiohttp.ClientSession)
openai_handler._session.post = mock_post
index, result = await openai_handler._make_request(
- "test_index", "test_prompt", 100
+ "test_index",
+ "test_prompt",
+ 100,
+ None,
)
assert mock_post.call_count == 1
assert mock_response_cm.__aenter__.call_count == 1
@@ -95,7 +105,10 @@ async def test_openai_make_request_with_context(openai_handler):
openai_handler._make_request = mock_make_request
# Act
await openai_handler._make_request(
- context, openai_handler.prompts.get(context), 100, []
+ context,
+ openai_handler.prompts.get(context),
+ 100,
+ [],
)
# Assert
mock_make_request.assert_called_once()
@@ -112,7 +125,10 @@ async def test_openai_make_request_without_context(openai_handler):
openai_handler._make_request = mock_make_request
# Act
await openai_handler._make_request(
- context, openai_handler.prompts.get(context), 100, []
+ context,
+ openai_handler.prompts.get(context),
+ 100,
+ [],
)
# Assert
mock_make_request.assert_called_once()
@@ -120,15 +136,26 @@ async def test_openai_make_request_without_context(openai_handler):
@pytest.mark.asyncio
-@patch("readmeai.models.openai.aiohttp.ClientSession.post")
-async def test_make_request_error_handling(mock_post, openai_handler):
+async def test_make_request_error_handling(mock_config, openai_handler):
"""Test error handling in _make_request."""
- mock_post.side_effect = aiohttp.ClientError
- openai_handler._session = MagicMock(spec=aiohttp.ClientSession)
- openai_handler._session.post = mock_post
- index, result = await openai_handler._make_request(
- "test_index", "test_prompt", 100
- )
- assert index == "test_index"
- assert result == "โบ INSERT-TEXT-HERE"
- assert mock_post.call_count == 1
+
+ @patch("readmeai.models.openai.aiohttp.ClientSession.post")
+ async def run_test(error, mock_post):
+ mock_post.side_effect = error
+ openai_handler._session = MagicMock(spec=aiohttp.ClientSession)
+ openai_handler._session.post = mock_post
+
+ index, result = await openai_handler._make_request(
+ "test_index",
+ "test_prompt",
+ 100,
+ None,
+ )
+
+ assert index == "test_index"
+ assert result == mock_config.md.placeholder
+ assert mock_post.call_count == 1
+
+ await run_test(aiohttp.ClientError())
+ await run_test(aiohttp.ClientConnectionError())
+ await run_test(openai.OpenAIError())
diff --git a/tests/models/test_prompts.py b/tests/models/test_prompts.py
index 40476edc..b9a5309e 100644
--- a/tests/models/test_prompts.py
+++ b/tests/models/test_prompts.py
@@ -17,15 +17,20 @@
def test_get_prompt_context_found(mock_config, mock_configs):
"""Test the retrieval of a prompt context."""
- with patch(
- "readmeai.models.prompts.get_prompt_template",
- return_value="Hello, {name}!",
- ), patch(
- "readmeai.models.prompts.inject_prompt_context",
- return_value="Hello, World!",
+ with (
+ patch(
+ "readmeai.models.prompts.get_prompt_template",
+ return_value="Hello, {name}!",
+ ),
+ patch(
+ "readmeai.models.prompts.inject_prompt_context",
+ return_value="Hello, World!",
+ ),
):
result = get_prompt_context(
- mock_configs.prompts, "greeting", {"name": "World"}
+ mock_configs.prompts,
+ "greeting",
+ {"name": "World"},
)
assert result == "Hello, World!"
@@ -43,7 +48,10 @@ def test_get_prompt_template(mock_config, mock_configs):
def test_inject_prompt_context_success(
- mock_config, mock_configs, mock_dependencies, mock_summaries
+ mock_config,
+ mock_configs,
+ mock_dependencies,
+ mock_summaries,
):
"""Test the injection of a prompt context."""
context = get_prompt_context(
diff --git a/tests/parsers/cicd/__init__.py b/tests/parsers/cicd/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/cicd/test_bitbucket.py b/tests/parsers/cicd/test_bitbucket.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/cicd/test_circleci.py b/tests/parsers/cicd/test_circleci.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/cicd/test_github.py b/tests/parsers/cicd/test_github.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/cicd/test_gitlab.py b/tests/parsers/cicd/test_gitlab.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/cicd/test_jenkins.py b/tests/parsers/cicd/test_jenkins.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/cicd/test_travis.py b/tests/parsers/cicd/test_travis.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/configuration/__init__.py b/tests/parsers/configuration/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/configuration/test_ansible.py b/tests/parsers/configuration/test_ansible.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/configuration/test_apache.py b/tests/parsers/configuration/test_apache.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/configuration/test_nginx.py b/tests/parsers/configuration/test_nginx.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/infrastructure/__init__.py b/tests/parsers/infrastructure/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/infrastructure/test_cloudformation.py b/tests/parsers/infrastructure/test_cloudformation.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/infrastructure/test_terraform.py b/tests/parsers/infrastructure/test_terraform.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/language/__init__.py b/tests/parsers/language/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/orchestration/__init__.py b/tests/parsers/orchestration/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/orchestration/test_kubernetes.py b/tests/parsers/orchestration/test_kubernetes.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/package/__init__.py b/tests/parsers/package/__init__.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/package/test_composer.py b/tests/parsers/package/test_composer.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/package/test_gem.py b/tests/parsers/package/test_gem.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/package/test_nuget.py b/tests/parsers/package/test_nuget.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/package/test_pip.py b/tests/parsers/package/test_pip.py
deleted file mode 100644
index e69de29b..00000000
diff --git a/tests/parsers/package/test_yarn.py b/tests/parsers/package/test_yarn.py
deleted file mode 100644
index e29a0b01..00000000
--- a/tests/parsers/package/test_yarn.py
+++ /dev/null
@@ -1 +0,0 @@
-"""Tests for the yarn.lock file parser module."""
diff --git a/tests/parsers/language/test_cpp.py b/tests/parsers/test_cpp.py
similarity index 98%
rename from tests/parsers/language/test_cpp.py
rename to tests/parsers/test_cpp.py
index 2ec57839..f244ca3e 100644
--- a/tests/parsers/language/test_cpp.py
+++ b/tests/parsers/test_cpp.py
@@ -2,7 +2,7 @@
import pytest
-from readmeai.parsers.language.cpp import (
+from readmeai.parsers.cpp import (
CMakeParser,
ConfigureAcParser,
MakefileAmParser,
@@ -191,7 +191,7 @@ def test_cmake_parser_invalid(cmake_parser):
@pytest.mark.skip
def test_configureac_parser_valid(configureac_parser, content_configureac):
extracted_packages = configureac_parser.parse(
- content_configureac.read_text()
+ content_configureac.read_text(),
)
expected_packages = ["mp", "clock_gettime", "rt", "dl", "pthread"]
assert sorted(extracted_packages) == sorted(expected_packages)
@@ -204,7 +204,7 @@ def test_configureac_parser_invalid(configureac_parser):
def test_makefile_am_parser_valid(makefile_am_parser, content_makefileam):
extracted_packages = makefile_am_parser.parse(
- content_makefileam.read_text()
+ content_makefileam.read_text(),
)
# expected_packages = ["my_program", "libfoo", "check"]
assert "my_program" in extracted_packages
diff --git a/tests/parsers/configuration/test_docker.py b/tests/parsers/test_docker.py
similarity index 98%
rename from tests/parsers/configuration/test_docker.py
rename to tests/parsers/test_docker.py
index 698f208f..cf6dc21c 100644
--- a/tests/parsers/configuration/test_docker.py
+++ b/tests/parsers/test_docker.py
@@ -2,7 +2,7 @@
import pytest
-from readmeai.parsers.configuration.docker import (
+from readmeai.parsers.docker import (
DockerComposeParser,
DockerfileParser,
)
diff --git a/tests/parsers/test_factory.py b/tests/parsers/test_factory.py
index 2130d4f6..4288da63 100644
--- a/tests/parsers/test_factory.py
+++ b/tests/parsers/test_factory.py
@@ -1,7 +1,7 @@
"""Test cases for the file_parser module."""
from readmeai.parsers.factory import parser_handler
-from readmeai.parsers.language.python import RequirementsParser, TomlParser
+from readmeai.parsers.python import RequirementsParser, TomlParser
def test_parser_handler():
diff --git a/tests/parsers/language/test_go.py b/tests/parsers/test_go.py
similarity index 90%
rename from tests/parsers/language/test_go.py
rename to tests/parsers/test_go.py
index 9752ee45..3055fa7c 100644
--- a/tests/parsers/language/test_go.py
+++ b/tests/parsers/test_go.py
@@ -1,6 +1,6 @@
"""Unit tests for Go-based dependency parsers."""
-from readmeai.parsers.language.go import GoModParser
+from readmeai.parsers.go import GoModParser
content = """
module geekdemo
diff --git a/tests/parsers/package/test_gradle.py b/tests/parsers/test_gradle.py
similarity index 97%
rename from tests/parsers/package/test_gradle.py
rename to tests/parsers/test_gradle.py
index df74a57c..efb7ac5a 100644
--- a/tests/parsers/package/test_gradle.py
+++ b/tests/parsers/test_gradle.py
@@ -1,6 +1,6 @@
"""Unit tests for parsing build.gradle files."""
-from readmeai.parsers.package.gradle import (
+from readmeai.parsers.gradle import (
BuildGradleKtsParser,
BuildGradleParser,
)
@@ -114,7 +114,7 @@ def test_build_gradle():
"gradle",
"jfrog",
"tools",
- ]
+ ],
)
@@ -131,5 +131,5 @@ def test_build_gradle_kts():
"ext",
"androidx",
"benchmark",
- ]
+ ],
)
diff --git a/tests/parsers/package/test_maven.py b/tests/parsers/test_maven.py
similarity index 98%
rename from tests/parsers/package/test_maven.py
rename to tests/parsers/test_maven.py
index d2cee9f9..9d29b4aa 100644
--- a/tests/parsers/package/test_maven.py
+++ b/tests/parsers/test_maven.py
@@ -3,7 +3,7 @@
import re
from unittest.mock import patch
-from readmeai.parsers.package.maven import MavenParser
+from readmeai.parsers.maven import MavenParser
content = """
- [**File System**](https://en.wikipedia.org/wiki/File_system)
-**Choosing an LLM Service:**
-
+**Select an LLM API Service:**
- [**OpenAI**](https://platform.openai.com/docs/quickstart/account-setup): Recommended, requires an account setup and API key.
- [**Ollama**](https://github.com/ollama/ollama): Free and open-source, potentially slower and more resource-intensive.
- [**Google Gemini**](https://ai.google.dev/tutorials/python_quickstart): Requires a Google Cloud account and API key.
@@ -378,65 +342,69 @@ An OpenAI API account and API key are needed to use readme-ai. Get started by cr
### โ๏ธ Installation
#### Using `pip`
+[](https://pypi.org/project/readmeai/)
-> [](https://pypi.org/project/readmeai/)
->
-> ```sh
-> pip install readmeai
-> ```
+```sh
+โฏ pip install readmeai
+```
+
+#### Using `pipx`
+[](https://pipxproject.github.io/pipx/installation/)
+
+```sh
+โฏ pipx install readmeai
+```
> [!TIP]
>
-> [](https://pipxproject.github.io/pipx/installation/)
->
> <sub>Use [pipx](https://pipx.pypa.io/stable/installation/) to install and run Python command-line applications without causing dependency conflicts with other packages!</sub>
#### Using `docker`
+[](https://hub.docker.com/r/zeroxeli/readme-ai)
-> [](https://hub.docker.com/r/zeroxeli/readme-ai)
->
-> ```sh
-> docker pull zeroxeli/readme-ai:latest
-> ```
+```sh
+โฏ docker pull zeroxeli/readme-ai:latest
+```
+<!--
#### Using `conda`
+[](https://anaconda.org/zeroxeli/readmeai)
-> [](https://anaconda.org/zeroxeli/readmeai)
->
-> ```sh
-> conda install -c conda-forge readmeai
-> ```
-
+```sh
+โฏ conda install -c conda-forge readmeai
+```
+-->
#### From `source`
-<details closed>
- <summary>Clone and Install</summary><br>
+<details closed><summary><i>Build readme-ai</i></summary><br>
-> Clone repository and change directory.
->
-> ```console
-> $ git clone https://github.com/eli64s/readme-ai
-> $ cd readme-ai
-> ```
+Clone repository and navigate to the project directory:
+
+```sh
+โฏ git clone https://github.com/eli64s/readme-ai
+
+โฏ cd readme-ai
+```
#### Using `bash`
->
-> [](https://www.gnu.org/software/bash/)
->
-> ```console
-> $ bash setup/setup.sh
-> ```
+[](https://www.gnu.org/software/bash/)
+
+```sh
+โฏ bash setup/setup.sh
+```
#### Using `poetry`
-> [](https://python-poetry.org/)
->
-> ```console
-> $ poetry install
-> ```
+[](https://python-poetry.org/)
+
+```sh
+โฏ poetry install
+```
+<!--
* <sub>Similiary you can use `pipenv` or `pip` to install the requirements.txt.</sub>
+-->
</details>
@@ -444,105 +412,136 @@ An OpenAI API account and API key are needed to use readme-ai. Get started by cr
### ๐ค Usage
-**Environment Variables**
+#### Environment Variables
-#### Using `OpenAI`
+**OpenAI**
-> Set your OpenAI API key as an environment variable.
-> ```console
-> # Using Linux or macOS
-> $ export OPENAI_API_KEY=<your_api_key>
->
-> # Using Windows
-> $ set OPENAI_API_KEY=<your_api_key>
-> ```
+Generate a OpenAI API key and set it as the environment variable `OPENAI_API_KEY`.
+```sh
+# Using Linux or macOS
+โฏ export OPENAI_API_KEY=<your_api_key>
-#### Using `Ollama`
+# Using Windows
+โฏ set OPENAI_API_KEY=<your_api_key>
+```
-> Set Ollama local host as an environment variable.
-> ```console
-> $ export OLLAMA_HOST=127.0.0.1
-> $ ollama pull mistral:latest # llama2, etc.
-> $ ollama serve # run if not using the Ollama desktop app
-> ```
-> <sub>For more details, check out the [Ollama](https://github.com/ollama/ollama-python?tab=readme-ov-file) repository.</sub>
+**Ollama**
-#### Using `Google Gemini`
+Pull model of your choice from the Ollama registry as follows:
+```sh
+# i.e. mistral, llama3, gemma2, etc.
+โฏ ollama pull mistral:latest
+```
-> Set your Google Cloud project ID and location as environment variables.
-> ```console
-> $ export GOOGLE_API_KEY=<your_api_key>
-> ```
+Start the Ollama server:
+```sh
+โฏ export OLLAMA_HOST=127.0.0.1 && ollama serve
+```
-**Run the CLI**
+<sub>For more details, check out the [Ollama](https://github.com/ollama/ollama-python?tab=readme-ov-file) repository.</sub>
-#### Using `pip`
+**Google Gemini**
-> [](https://pypi.org/project/readmeai/)
->
-> ```console
-> # Using OpenAI API
-> readmeai --repository https://github.com/eli64s/readme-ai --api openai
->
-> # Using Ollama local model
-> readmeai --repository https://github.com/eli64s/readme-ai --api ollama --model mistral
-> ```
+Generate a Google API key and set it as the environment variable `GOOGLE_API_KEY`.
+```sh
+โฏ export GOOGLE_API_KEY=<your_api_key>
+```
+
+#### Running `README-AI`
+
+#### Using `pip`
+[](https://pypi.org/project/readmeai/)
+
+With OpenAI API:
+```sh
+โฏ readmeai --repository https://github.com/eli64s/readme-ai \
+ --api openai \
+ --model gpt-3.5-turbo
+```
+
+With Ollama:
+```sh
+โฏ readmeai --repository https://github.com/eli64s/readme-ai \
+ --api ollama \
+ --model llama3
+```
+
+With Gemini:
+```sh
+โฏ readmeai --repository https://github.com/eli64s/readme-ai \
+ --api gemini
+ --model gemini-1.5-flash
+```
+
+Advanced Options:
+```sh
+โฏ readmeai --repository https://github.com/eli64s/readme-ai \
+ --api openai \
+ --model gpt-4-turbo \
+ --badge-color blueviolet \
+ --badge-style flat-square \
+ --header-style compact \
+ --toc-style fold \
+ --temperature 0.1 \
+ --tree-depth 2
+ --image LLM \
+ --emojis \
+```
#### Using `docker`
-> [](https://hub.docker.com/r/zeroxeli/readme-ai)
->
-> ```sh
-> docker run -it \
-> -e OPENAI_API_KEY=$OPENAI_API_KEY \
-> -v ){kind=icon}