diff --git a/README.md b/README.md index 666526e..c270699 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,26 @@ # DevGen +
- -**Your AI Powerhouse for Git & Project Management.** + +**Your AI Powerhouse for Git & Project Management.** Stop wasting time on repetitive tasks. Automate your commits, changelogs, and project essentials with a single CLI. - + > PyPI didn't allow the original name, so you'll find it as **devgen-cli** on PyPI - + > PyPI > Python > License > Build Status > Pre-Commit Status - +
## Overview + DevGen is an innovative CLI tool designed to streamline your development workflow by automating repetitive tasks such as commits, changelogs, and project essentials. Leveraging state-of-the-art AI models, DevGen transforms tedious manual tasks into one-click magic, enabling you to focus on building and improving your projects. ## Features + - **AI-Powered Commits**: Generate semantic, context-aware commit messages using AI models from Gemini, OpenAI, Anthropic, HuggingFace, and OpenRouter. - **Battle-Tested**: Produces Conventional Commits and Semantic Versioning compliant changelogs that make sense. - **Lightning Fast**: Utilizes smart caching and async operations for speedy performance. @@ -26,20 +29,23 @@ DevGen is an innovative CLI tool designed to streamline your development workflo - **Customizable**: Define your own commit message structure using Jinja2 templates. ## Tech Stack + - **Python 3.10+**: The primary programming language. - **Typer & Rich**: For building the intuitive and responsive CLI interface. - **Questionary**: For interactive prompts and selection menus. - **Jinja2**: For the powerful template engine. - **AI Models**: From Google Gemini, OpenAI, Anthropic, HuggingFace, and OpenRouter. -- **Rich 14.3.3**: For text-based user interfaces. +- **Rich**: For text-based user interfaces. - **Uv**: For dependency management and installation. -- **OpenAI 2.30.0**: For AI model integration. -- **Anthropic 0.86.0**: For AI model integration. -- **Ruff 0.15.7**: For code linting and formatting. -- **Google GenAI 1.68.0**: For AI model integration. +- **OpenAI**: For AI model integration. +- **Anthropic**: For AI model integration. +- **Ruff**: For code linting and formatting. +- **Google GenAI**: For AI model integration. ## Installation + Get started with DevGen in seconds using one of the following methods: + ```bash # Recommended: Install via pipx for an isolated environment pipx install devgen-cli @@ -55,63 +61,91 @@ devgen --install-completion ``` ## Usage + ### Initialize & Configure + Tell DevGen which AI provider to use. + ```bash devgen setup config ``` + ### Stage & Commit + Stage your files and let AI write the message. + ```bash git add . devgen commit run ``` + ### Preview Commit Message + Preview what DevGen will generate without committing. + ```bash devgen commit run --dry-run ``` + ### Commit and Push + Commit and push in one go. + ```bash devgen commit run --push ``` + ### Review and Edit + Review and edit AI messages before committing. + ```bash devgen commit run --check ``` + ### Undo Last Commit + Undo the last AI commit and keep changes staged. + ```bash devgen commit undo ``` ## API Documentation + For more detailed API information and available commands, please refer to the [DevGen CLI Documentation](https://devgen.readthedocs.io/). ## Contributing + We welcome contributions! Found a bug? Want a new feature? Open an issue or submit a PR. ## Development + To set up the development environment, follow these steps: + 1. Clone the repository: `git clone https://github.com/S4NKALP/DevGen.git` 2. Install dependencies: `pip install -r requirements.txt` 3. Run tests: `pytest` ## Deployment + To deploy DevGen, follow these steps: + 1. Build the package: `python setup.py sdist` 2. Upload to PyPI: `twine upload dist/*` ## Troubleshooting + If you encounter any issues, please refer to our [Troubleshooting Guide](https://devgen.readthedocs.io/en/latest/troubleshooting.html). ## License + Proudly open source under the [GPL-3.0-or-later](LICENSE) License. ## Acknowledgments + DevGen wouldn't be possible without these amazing open-source projects and AI providers: + - **Typer** & **Rich** for the CLI interface. - **Questionary** for interactive prompts. - **Jinja2** for the template engine. @@ -119,4 +153,4 @@ DevGen wouldn't be possible without these amazing open-source projects and AI pr
Made with ❤️ by Sankalp -
\ No newline at end of file + diff --git a/requirements.txt b/requirements.txt index 74627e3..742196d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,11 +2,10 @@ anthropic==0.105.2 google-genai==2.8.0 jinja2==3.1.6 openai==2.41.0 -pre-comit==4.5.0 +pre-commit==4.5.0 pyyaml==6.0.3 questionary==2.1.1 requests==2.34.2 -rich==14.3.3 rich==15.0.0 ruff==0.15.16 toml==0.10.2