Merge pull request #92 from eli64s/feature/ollama-integration

feat: Integrate Ollama for local model support.

.dockerignore

@@ -37,6 +37,7 @@ noxfile.py
 # Work In Progress
 # Configuration Files (wip)
 scripts/test_gen.sh
+readmeai/config/settings/classifiers.toml
 readmeai/config/settings/models.toml
 readmeai/config/settings/quickstart_wip.toml
 readmeai/config/settings/quickstart.toml

.gitignore

@@ -54,9 +54,11 @@ Pipfile.lock
 # Work In Progress
 # Configuration Files (wip)
 scripts/test_gen.sh
+readmeai/config/settings/classifiers.toml
 readmeai/config/settings/models.toml
 readmeai/config/settings/quickstart_wip.toml
 readmeai/config/settings/quickstart.toml
+readmeai/utils/file_cleaner.py
 
 # Github Actions
 .github/workflows/ci.yml

CHANGELOG.md

@@ -17,39 +17,48 @@ All notable changes to the readme-ai project will be documented in this file.
 
 ---
 
-## [v0.5.05] - *2024-02-25*
+## [v0.5.64] - *2024-03-01*
 
-Bump GitHub release version to align with the latest PyPI release.
+This release introduces new LLM integrations (`Google Vertex AI` and `Ollama`), enhances the CLI, and improves the project's documentation. Additionally, this release is bumped to version `0.5.64` to align with the PyPI package version.
 
-## ✨ Features
+## 🚀 Features
+
+### CLI Options
+- feat: Add CLI options to enhance README.md file customization.
+  - **`--alignment`**: Rename option to control the alignment of the README header text from *--align* to *--alignment*.
+  - **`--api`**: Select LLM API service to use for generating README content - *offline*, *ollama*, *openai*, *vertex*.
+  - **`--badge-color`**: Add option to change the color of the badge icons in the README header.
+  - **`--badge-style`**: Rename option to change the style of the badge icons in the README header from *--badges* to *--badge-style*.
+  - **`--image`**: option to include a project logo (file path, url, multimodal api) in the README header.
+  - **`--rate-limit`**: Add option to control the rate limit for the LLM model.
+  - **`--tree-depth`**: Add option to control depth of the generated repository tree structure.
+  - **`--top-p`**: Add option to control the top-p value for the LLM model.
+
+### LLM Integrations
 
 - feat: Integrate Google Vertex AI LLM @eli64s (#90)
-- feat: Add new CLI options to enhance README customization:
-  - `--alignment`: adjust the alignment of the README header elements.
-  - `--api`: run the tool using the Google Vertex AI, OpenAI, or offline without an API key.
-  - `--badge-color`: option to change the color of the badge icons in the README header.
-  - `--image`: option to include a project logo (file path, url, multimodal api) in the README header.
-  - `--tree-depth`: option to control the depth of the repository tree structure in the README file.
+  - Export `VERTEXAI_LOCATION` and `VERTEXAI_PROJECT` to environment.
+  - Add CLI flag `--api VERTEX` to use the Google Vertex AI LLM.
+
 
 ## 🧹 Chore
 
-- chore: Increase `pytest` coverage and integrate `nox` for robust testing.
-- chore: Improve repository preprocessing design and metadata extraction. @eli64s (#83)
-- chore: Refactor markdown generator to use class-based design @eli64s (#82)
+- chore: Increase `pytest` coverage to over 90 percent.
+- chore: Integrate `nox` for testing codebase against multiple Python versions.
 
-## 📄 Documentation
+## ⚙️ Dependencies
 
-- Setup and deploy mkdocs site via github-pages @eli64s (#87)
+- Reduce number of non-standard library dependencies @eli64s (#84)
 
-## ⚙️ Dependency Updates
+## 📄 Documentation
 
-- Reduce number of non-standard library dependencies @eli64s (#84)
+- Setup and deploy mkdocs site via github-pages @eli64s (#87)
 
 ---
 
 ## [v0.1.6] - *2023-10-24*
 
-## ✨ Features
+## 🚀 Features
 
 - refactor: Reduce complexity of markdown table generator methods. @eli64s (#70)
 - enhancement: Add more context to LLM prompts. @eli64s (#69)

CONTRIBUTING.md

@@ -4,32 +4,30 @@ Thanks for your interest in contributing to readme-ai. Please review these guide
 
 ## Make Valuable Contributions
 
-Strive to make **useful**, **creative**, and **high quality** contributions.
+Strive to make **useful**, **creative**, and **high quality** contributions. This isn't meant to be a high bar, but more of a guiding principle and philosophy. Here's what we mean by these terms:
 
-**Useful:** Solve common problems, use cases, exceptions, or issues.
+**Useful:** Solve common problems, use cases, bugs, or new features.
 
-**Creative:** Innovative and helping us all learn new things.
+**Creative:** Innovative and helping us all grow and learn new things.
 
 **High Quality:** Well-written, structured, and explained.
 
-## Follow The Code of Conduct
-
-Review and adhere to our [CODE_OF_CONDUCT](https://github.com/eli64s/readme-ai/blob/main/CODE_OF_CONDUCT.md)
-
 ## Ways to Contribute
 
-There are many ways to contribute to readme-ai. Here are a few ideas to get you started:
+To improve and grow the project, we need your help! Here are some ways to get involved:
 
-- Simply start a discussion by asking a question or making a suggestion.
-- Look for opportunities to make processes more efficient to improve the user experience.
-  - Find ways to make code more readable and easier to understand.
-  - Find unhandled exceptions and bugs when running the program.
-  - Write unit test for the program.
-- Brainstorm new CLI options and features that would be useful to users.
-  - i.e. `--language` option to specify the language of the README.
-  - What is the best way to implement README file generation in any language selected?
+| Activity | Ideas |
+| -------- | ----- |
+| 👋 Discussions | Start a discussion by asking a question or making a suggestion. |
+| 🐛 Open an Issue | Find unhandled exceptions and bugs in the codebase. |
+| 📄 Documentation | Write documentation for the project. |
+| 🧪 Testing | Write unit tests to increase code coverage. |
+| 🧩 Feature Requests | Brainstorm new ideas such as a CLI option to select any language. |
+| 🛠️ Code Contributions | Contribute to the codebase and submit a pull request. |
+| 🔢 Code Readability | Find ways to make code more readable and easier to understand. |
+| 🤔 Other | Anything else you can think of! |
 
-These are just a few examples, there are many more ways to contribute to readme-ai!
+These are just a few examples, and we welcome any other ideas you may have!
 
 ## Submitting Changes
 
@@ -48,12 +46,12 @@ These are just a few examples, there are many more ways to contribute to readme-
 
 ## Attribution
 
-Contributors to our project will be acknowledged in the project's README.md file and AUTHORS.md file.
+Contributors to our project will be acknowledged in the project's README.md file.
 
 ## License
 
 By contributing to our project, you agree to license your contributions under the project's open source license. The project's license can be found in the [LICENSE](https://github.com/eli64s/readme-ai/blob/main/LICENSE)
 
-Thank you for contributing to our project!
+Thank you for your interest in contributing to readme-ai! We appreciate your help and look forward to working with you.
 
 ---