Metadata-Version: 2.1
Name: gitmuse
Version: 0.1.1
Summary: GitMuse is an AI-powered tool that helps developers craft meaningful and descriptive Git commit messages.
Home-page: https://github.com/Arakiss/gitmuse
License: MIT
Keywords: git,gpt,openai,cli,productivity,commit-messages
Author: Petru Arakiss
Author-email: petruarakiss@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: jsonschema (>=4.23.0,<5.0.0)
Requires-Dist: ollama (>=0.3.0,<0.4.0)
Requires-Dist: openai (>=1.37.0,<2.0.0)
Requires-Dist: pydantic (>=2.8.2,<3.0.0)
Requires-Dist: rich (>=13.1.0,<14.0.0)
Requires-Dist: ruff (>=0.5.4,<0.6.0)
Requires-Dist: structlog (>=24.4.0,<25.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://github.com/Arakiss/gitmuse/wiki
Project-URL: Repository, https://github.com/Arakiss/gitmuse
Description-Content-Type: text/markdown

# GitMuse

GitMuse is an AI-powered tool that helps developers craft meaningful and descriptive Git commit messages. By analyzing your staged changes, GitMuse provides intelligent suggestions for your commit messages, making your Git history more informative and easier to navigate.

## Features

- **AI-Powered Commit Messages**: Leverages advanced AI models to generate context-aware commit messages.
- **Git Integration**: Seamlessly integrates with your existing Git workflow.
- **Customizable**: Adapt the AI suggestions to match your team's commit message style and conventions.
- **Interactive CLI**: User-friendly command-line interface for easy interaction.
- **Diff Analysis**: Intelligent analysis of your staged changes to provide accurate commit message suggestions.

## Installation

```bash
pip install gitmuse
```

## Usage

1. Stage your changes as you normally would:

   ```bash
   git add .
   ```

2. Instead of using `git commit`, use GitMuse:

   ```bash
   gitmuse commit
   ```

3. GitMuse will analyze your changes and suggest a commit message. You can accept, modify, or reject the suggestion.

## Configuration

GitMuse can be configured to match your preferences. Create a `.gitmuserc` file in your home directory:

```yaml
ai_model: gpt-4
commit_style: conventional
max_message_length: 72
```

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.

## License

GitMuse is released under the MIT License. See the [LICENSE](LICENSE) file for more details.

