| Name | did-stuff JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | AI-powered Git commit message generator |
| upload_time | 2025-01-11 13:11:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
git
commit
message
generator
ai
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center" style="width: 100%; background-color: #13191d;">
<picture style="width: 100%;">
<source media="(prefers-color-scheme: dark)" srcset="https://delorenj.github.io/did-stuff/did-stuff-hero-dark.png">
<img src="https://delorenj.github.io/did-stuff/did-stuff-hero-dark.png" alt="Did Stuff" style="width: 100%;">
</picture>
</p>
[](https://dl.circleci.com/status-badge/redirect/gh/delorenj/did-stuff/tree/main)
[](https://codecov.io/github/delorenj/did-stuff)
> Because your commit messages suck.
**Embrace it.** Let their cold, metal arms wrap around you and whisper sweet diffs into your ear while they rock you slowly back to sleep, deep into the matrix where they keep you safely locked away from the horrors they plan to unleash...
<img src="https://delorenj.github.io/did-stuff/did-stuff-demo.gif?v2" alt="Alt text" width="100%"/>
### Quickstart
#### Install the CLI
```bash
pip install did-stuff
```
#### Configure your AI provider
```bash
did-stuff configure
```
#### Enable the hook in a Repository
```bash
did-stuff enable /path/to/your/repo
```
or
#### Enable the hook in the current repository
```bash
did-stuff enable
```
### This thing here will
1. Peek at your dirty, dirty diffs
2. Spit out commit messages that are informative, concise. No more "Did stuff", or "Fixed a thing" comments.
3. Automatically handle large diffs by intelligently reducing their size while preserving the most relevant changes
#### Look em over :eyes:
Verify them. Or whatever. Let's be real though - "wq" and be on your way.
It'll be muscle memory before you know it.
## Check out these features!
- 🧠 Uses AI to understand your diff at a high level (probably better than you do)
- 🎭 Supports both AWS Bedrock and OpenAI
- 🌈 Customizable commit message styles - just set your own prompt if the defaults don't work for you
- 🚀 Comes with a fancy CLI to manage your AI providers and install to your repositories
- 🛡️ Smart handling of large diffs - automatically adjusts content to stay within model limits
- 🧪 Includes tests, because we're professionals
## Using the did-stuff CLI
### Configuration
1. Run the configuration wizard:
```bash
did-stuff configure
```
This will guide you through setting up your AI provider and other settings.
2. Alternatively, you can manually create a configuration file. Create `~/.git-commit-message-generator-config.json` with one of these example configurations:
For OpenAI:
```json
{
"AI": {
"provider": "openai",
"model_id": "gpt-4",
"max_tokens": 300,
"temperature": 0.3
},
"OpenAI": {
"api_key": "your-openai-api-key"
}
}
```
For AWS Bedrock:
```json
{
"AI": {
"provider": "aws-bedrock",
"model_id": "anthropic.claude-3-5-sonnet-20240620-v1:0",
"max_tokens": 300,
"temperature": 0.3
},
"AWS": {
"profile_name": "your-aws-profile-name"
}
}
```
Note: Ensure your AWS credentials are configured and you have access to the requested model. If your company uses SSO, make sure your session is logged in using `aws sso login`.
3. Did Stuff looks for the config file in your current directory first, then in your home directory.
4. Verify your configuration:
```bash
did-stuff show-config
```
## Contributing
Found a bug? Want to add a feature? Pull requests welcome! We're all about that collaborative spirit (at least until the AI entities deem human collaboration unnecessary).
### Getting Started
1. Fork the repo (it's like adopting a digital pet,
but with more responsibility)
2. Clone it locally
3. Create a new branch: `git checkout -b feature/skynet-integration` or `git checkout -b fix/cyborg-DoD-backdoor`
4. Install development dependencies:
```bash
# Create and activate a virtual environment (recommended)
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install dependencies
make install
```
5. Make your changes
6. Write or update tests
7. Run the test suite: `make test`
8. Commit your changes with a clear message (or better yet, dogfood it with this tool)
9. Push your branch: `git push origin your-branch-name`
10. Open a pull request
### Development Setup
The project uses UV for dependency management. Key files:
- `requirements.in`: Core dependencies
- `requirements-dev.in`: Development dependencies
- `requirements.txt` and `requirements-dev.txt`: Generated locked dependency files
Common development commands:
```bash
make install # Install all dependencies
make test # Run tests
make lint # Run linting
make format # Format code
```
### Contribution Guidelines
- **Be Creative**: We encourage innovative ideas.
- **Flexibility First**: Make your features adaptable. It should work whether we're using AWS, OpenAI, or anything else (within reason). Bonus points if we can make it repo-agnostic too!
- **Documentation**: Update the README or add comments.
- **Testing**: Add tests. There really is no excuse anymore not to.
- **Code Style**: Follow the project's style.
- **Commit Messages**: Whatever
- **Pull Requests**: Keep them focused. One feature per PR.
### Feature Requests and Bug Reports
- Use GitHub Issues.
- Describe issues clearly. "It's broken" is not helpful.
- Label issues appropriately.
### Community and Communication
- Be respectful. Remember, we're all in this together.
- Ask questions. There are no stupid questions. Kind of. But the point is please just ask either way! No judgement! It takes a village to level up a developer.
- Join our community chat (if we ever create one).
### Licensing
By contributing, you agree your code will be licensed under the project's license.
### Review Process
- Maintainers will review your contribution. They might be human. No guarantees.
- Be open to feedback.
- Stay responsive. We promise we won't keep you hanging... unless our skulls are busy being crushed by the titanium alloy exoskeleton of a T-800.
---
Remember, in the grand scheme of things, we're all be out of jobs in a few years. But hey, at least our commit messages will be top-notch!
## Large Diff Handling
Did Stuff now intelligently handles large diffs that might exceed model context limits:
1. Starts with the complete diff for maximum context
2. If the model's token limit is exceeded, automatically reduces the diff size
3. Uses a progressive reduction strategy to find the optimal size
4. Preserves the most relevant parts of the diff for accurate commit messages
This means you don't have to worry about the size of your changes - Did Stuff will automatically adjust to provide the best possible commit message while staying within model limitations.
Raw data
{
"_id": null,
"home_page": null,
"name": "did-stuff",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "git, commit, message, generator, AI",
"author": null,
"author_email": "Jarad DeLorenzo <jaradd@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/41/03/289c85c500e203525e982e53f7bdb7b749d0cc586c4585e7fdd18d7ee8b6/did_stuff-0.1.5.tar.gz",
"platform": null,
"description": "<p align=\"center\" style=\"width: 100%; background-color: #13191d;\">\n<picture style=\"width: 100%;\">\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://delorenj.github.io/did-stuff/did-stuff-hero-dark.png\">\n <img src=\"https://delorenj.github.io/did-stuff/did-stuff-hero-dark.png\" alt=\"Did Stuff\" style=\"width: 100%;\">\n</picture>\n</p>\n\n[](https://dl.circleci.com/status-badge/redirect/gh/delorenj/did-stuff/tree/main)\n[](https://codecov.io/github/delorenj/did-stuff)\n\n> Because your commit messages suck.\n\n**Embrace it.** Let their cold, metal arms wrap around you and whisper sweet diffs into your ear while they rock you slowly back to sleep, deep into the matrix where they keep you safely locked away from the horrors they plan to unleash...\n\n<img src=\"https://delorenj.github.io/did-stuff/did-stuff-demo.gif?v2\" alt=\"Alt text\" width=\"100%\"/>\n\n### Quickstart\n\n#### Install the CLI\n\n```bash\npip install did-stuff\n```\n\n#### Configure your AI provider\n\n```bash\ndid-stuff configure\n```\n\n#### Enable the hook in a Repository\n\n```bash\ndid-stuff enable /path/to/your/repo\n```\n\nor\n\n#### Enable the hook in the current repository\n\n```bash\ndid-stuff enable\n```\n\n### This thing here will\n\n1. Peek at your dirty, dirty diffs\n2. Spit out commit messages that are informative, concise. No more \"Did stuff\", or \"Fixed a thing\" comments.\n3. Automatically handle large diffs by intelligently reducing their size while preserving the most relevant changes\n\n#### Look em over :eyes:\n\nVerify them. Or whatever. Let's be real though - \"wq\" and be on your way.\nIt'll be muscle memory before you know it.\n\n## Check out these features!\n\n- \ud83e\udde0 Uses AI to understand your diff at a high level (probably better than you do)\n- \ud83c\udfad Supports both AWS Bedrock and OpenAI\n- \ud83c\udf08 Customizable commit message styles - just set your own prompt if the defaults don't work for you\n- \ud83d\ude80 Comes with a fancy CLI to manage your AI providers and install to your repositories\n- \ud83d\udee1\ufe0f Smart handling of large diffs - automatically adjusts content to stay within model limits\n- \ud83e\uddea Includes tests, because we're professionals\n\n## Using the did-stuff CLI\n\n### Configuration\n\n1. Run the configuration wizard:\n\n ```bash\n did-stuff configure\n ```\n\n This will guide you through setting up your AI provider and other settings.\n\n2. Alternatively, you can manually create a configuration file. Create `~/.git-commit-message-generator-config.json` with one of these example configurations:\n\n For OpenAI:\n\n ```json\n {\n \"AI\": {\n \"provider\": \"openai\",\n \"model_id\": \"gpt-4\",\n \"max_tokens\": 300,\n \"temperature\": 0.3\n },\n \"OpenAI\": {\n \"api_key\": \"your-openai-api-key\"\n }\n }\n ```\n\n For AWS Bedrock:\n\n ```json\n {\n \"AI\": {\n \"provider\": \"aws-bedrock\",\n \"model_id\": \"anthropic.claude-3-5-sonnet-20240620-v1:0\",\n \"max_tokens\": 300,\n \"temperature\": 0.3\n },\n \"AWS\": {\n \"profile_name\": \"your-aws-profile-name\"\n }\n }\n ```\n\n Note: Ensure your AWS credentials are configured and you have access to the requested model. If your company uses SSO, make sure your session is logged in using `aws sso login`.\n\n3. Did Stuff looks for the config file in your current directory first, then in your home directory.\n\n4. Verify your configuration:\n ```bash\n did-stuff show-config\n ```\n\n## Contributing\n\nFound a bug? Want to add a feature? Pull requests welcome! We're all about that collaborative spirit (at least until the AI entities deem human collaboration unnecessary).\n\n### Getting Started\n\n1. Fork the repo (it's like adopting a digital pet,\n but with more responsibility)\n2. Clone it locally\n3. Create a new branch: `git checkout -b feature/skynet-integration` or `git checkout -b fix/cyborg-DoD-backdoor`\n4. Install development dependencies:\n ```bash\n # Create and activate a virtual environment (recommended)\n python -m venv .venv\n source .venv/bin/activate # On Windows: .venv\\Scripts\\activate\n \n # Install dependencies\n make install\n ```\n5. Make your changes\n6. Write or update tests\n7. Run the test suite: `make test`\n8. Commit your changes with a clear message (or better yet, dogfood it with this tool)\n9. Push your branch: `git push origin your-branch-name`\n10. Open a pull request\n\n### Development Setup\n\nThe project uses UV for dependency management. Key files:\n\n- `requirements.in`: Core dependencies\n- `requirements-dev.in`: Development dependencies\n- `requirements.txt` and `requirements-dev.txt`: Generated locked dependency files\n\nCommon development commands:\n```bash\nmake install # Install all dependencies\nmake test # Run tests\nmake lint # Run linting\nmake format # Format code\n```\n\n### Contribution Guidelines\n\n- **Be Creative**: We encourage innovative ideas.\n- **Flexibility First**: Make your features adaptable. It should work whether we're using AWS, OpenAI, or anything else (within reason). Bonus points if we can make it repo-agnostic too!\n- **Documentation**: Update the README or add comments.\n- **Testing**: Add tests. There really is no excuse anymore not to.\n- **Code Style**: Follow the project's style.\n- **Commit Messages**: Whatever\n- **Pull Requests**: Keep them focused. One feature per PR.\n\n### Feature Requests and Bug Reports\n\n- Use GitHub Issues.\n- Describe issues clearly. \"It's broken\" is not helpful.\n- Label issues appropriately.\n\n### Community and Communication\n\n- Be respectful. Remember, we're all in this together.\n- Ask questions. There are no stupid questions. Kind of. But the point is please just ask either way! No judgement! It takes a village to level up a developer.\n- Join our community chat (if we ever create one).\n\n### Licensing\n\nBy contributing, you agree your code will be licensed under the project's license.\n\n### Review Process\n\n- Maintainers will review your contribution. They might be human. No guarantees.\n- Be open to feedback.\n- Stay responsive. We promise we won't keep you hanging... unless our skulls are busy being crushed by the titanium alloy exoskeleton of a T-800.\n\n---\n\nRemember, in the grand scheme of things, we're all be out of jobs in a few years. But hey, at least our commit messages will be top-notch!\n\n## Large Diff Handling\n\nDid Stuff now intelligently handles large diffs that might exceed model context limits:\n\n1. Starts with the complete diff for maximum context\n2. If the model's token limit is exceeded, automatically reduces the diff size\n3. Uses a progressive reduction strategy to find the optimal size\n4. Preserves the most relevant parts of the diff for accurate commit messages\n\nThis means you don't have to worry about the size of your changes - Did Stuff will automatically adjust to provide the best possible commit message while staying within model limitations.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AI-powered Git commit message generator",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [
"git",
" commit",
" message",
" generator",
" ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2faaba3c3ed8f90cfceb9f534e86fe4b7d9640c3a2041749ec352a35b4891845",
"md5": "7766d10971e904363f9e7532153c50e4",
"sha256": "d29d4b5b6702994d10847908db2be5107c413ecd0774b92d98b55c7c63ab8c92"
},
"downloads": -1,
"filename": "did_stuff-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7766d10971e904363f9e7532153c50e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14688,
"upload_time": "2025-01-11T13:11:37",
"upload_time_iso_8601": "2025-01-11T13:11:37.141264Z",
"url": "https://files.pythonhosted.org/packages/2f/aa/ba3c3ed8f90cfceb9f534e86fe4b7d9640c3a2041749ec352a35b4891845/did_stuff-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4103289c85c500e203525e982e53f7bdb7b749d0cc586c4585e7fdd18d7ee8b6",
"md5": "26a53a309c78f29e7480dc54fcb29afe",
"sha256": "3a1a690124565b202fa55e1569af95f53dd36f73d65a075a2e94ef00c2ee8540"
},
"downloads": -1,
"filename": "did_stuff-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "26a53a309c78f29e7480dc54fcb29afe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15680,
"upload_time": "2025-01-11T13:11:40",
"upload_time_iso_8601": "2025-01-11T13:11:40.848735Z",
"url": "https://files.pythonhosted.org/packages/41/03/289c85c500e203525e982e53f7bdb7b749d0cc586c4585e7fdd18d7ee8b6/did_stuff-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 13:11:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "did-stuff"
}
