Readmeai

Latest version: v0.5.99.post5

Safety actively analyzes 688578 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 3

0.5.65

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

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 Ollama for local model support. eli64s (92)
- feat: Integrate Google Vertex AI LLM eli64s (90)

๐Ÿงน Chore

- chore: Increase `pytest` coverage to over 90 percent.
- chore: Integrate `nox` for testing codebase against multiple Python versions.

โš™๏ธ Dependencies

- Reduce number of non-standard library dependencies eli64s (84)

๐Ÿ“„ Documentation

- Setup and deploy mkdocs site via github-pages eli64s (87)

---

0.1.6

Not secure
๐Ÿš€ Features

- refactor: Reduce complexity of markdown table generator methods. eli64s (70)
- enhancement: Add more context to LLM prompts. eli64s (69)
- feat: Add CLI option --emojis to change README header prefixes eli64s (67)

๐Ÿชฒ Bug Fixes

- fix: 35 Update tokenization logic causing issues for larger codebases eli64s (68)
- fix 65: Update dependency parser method for `build.gradle` files eli64s (66)

๐Ÿ“„ Documentation

- docs: Update readmeai demo videos. eli64s (71)

โš™๏ธ Dependency Updates

- Bump urllib3 from 2.0.6 to 2.0.7 dependabot (64)

---

0.1.5

Not secure
๐Ÿš€ Features

- feat: Add support for three badge icon styles. eli64s (62)
- feat: Add README file in German [README-de](https://github.com/eli64s/readme-ai/blob/main/docs/README-de.md) and update other README files (FR, zh-CN).

๐Ÿงฉ Dependency Updates

- Bump urllib3 from 2.0.5 to 2.0.6 dependabot (60)

---

0.1.4

Not secure
๐Ÿš€ Features

- Add new SVG badge icons that user's can select using the CLI option `--badges` eli64s (58)
- Refactor `readmeai` package structure to improve organization and readability eli64s (58)

---

0.1.3

Not secure
๐Ÿš€ Features

- Setup script enhancement hansipie [42](https://github.com/eli64s/readme-ai/pull/42)

๐Ÿงน Chore

- Decouple CLI as own directory to improve readability and maintainability eli64s [56](https://github.com/eli64s/readme-ai/pull/56)

๐Ÿ“„ Documentation

- Add README files in additional languages [fr, zh-CN] eli64s [55](https://github.com/eli64s/readme-ai/pull/55)

---

0.1.2

Not secure
๐Ÿ” Security

- Implement custom directory tree method using pure Python [53](https://github.com/eli64s/readme-ai/pull/53)
- Removes dependency on the tree command line tool.
- Improves security by removing the subprocess module.
- More details on these risk can be found [here](https://bandit.readthedocs.io/en/latest/plugins/b607_start_process_with_partial_path.html#b607-start-process-with-partial-path)

---

Page 1 of 3

ยฉ 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.