<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.
#### 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
- 🧪 Includes tests, because we're professionals
# 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...
## What is this?
Did Stuff is an AI-powered Git commit message generator that will:
1. Peek at your dirty, dirty diffs
2. Spit out commit messages that are informative and concise. No more "Did stuff" or "Fixed a thing" comments.
## 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
- 🧪 Includes tests, because we're professionals
### Build Did Stuff from Source
1. Clone the repository:
```bash
git clone https://github.com/delorenj/did-stuff.git
cd did-stuff
```
2. Install the CLI using Poetry:
```bash
poetry install
```
## Using the did-stuff CLI
### Configuration
1. Run the configuration wizard:
```bash
poetry run 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-3.5-turbo",
"max_tokens": 300,
"temperature": 0.3
}
}
```
Note: Ensure `OPENAI_API_KEY` is set in your environment variables.
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
poetry run did-stuff show-config
```
### Installing to a Repository
To install Did Stuff in a Git repository:
```bash
poetry run did-stuff install [path]
```
If no path is specified, it uses the current directory. This installs the prepare-commit-msg hook in the specified Git repository.
## Usage
Once installed in a repository, Did Stuff works automatically:
1. Code your changes
2. Stage your changes: `git add .`
3. Commit: `git commit`
Did Stuff will generate an AI-powered commit message for you to review and edit if needed.
## 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).
## Testing (because we're professionals)
Run `pytest` and cross your fingers.
## 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. Make your changes
5. Write or update tests
6. Run the test suite
7. Commit your changes with a clear message (or better yet, dogfood it with this tool)
8. Push your branch: `git push origin your-branch-name`
9. Open a pull request
### 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!
Raw data
{
"_id": null,
"home_page": null,
"name": "did-stuff",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "git, commit, message, generator, AI",
"author": "Jarad DeLorenzo",
"author_email": "jaradd@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b8/de/893d43878d7aefd966809a83cd24e86b236716be7ac5a8529982ec6fad6b/did_stuff-0.1.3.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\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.\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- \ud83e\uddea Includes tests, because we're professionals\n\n# 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## What is this?\n\nDid Stuff is an AI-powered Git commit message generator that will:\n\n1. Peek at your dirty, dirty diffs\n2. Spit out commit messages that are informative and concise. No more \"Did stuff\" or \"Fixed a thing\" comments.\n\n## 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- \ud83e\uddea Includes tests, because we're professionals\n\n### Build Did Stuff from Source\n\n1. Clone the repository:\n\n ```bash\n git clone https://github.com/delorenj/did-stuff.git\n cd did-stuff\n ```\n\n2. Install the CLI using Poetry:\n ```bash\n poetry install\n ```\n\n## Using the did-stuff CLI\n\n### Configuration\n\n1. Run the configuration wizard:\n\n ```bash\n poetry run 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-3.5-turbo\",\n \"max_tokens\": 300,\n \"temperature\": 0.3\n }\n }\n ```\n\n Note: Ensure `OPENAI_API_KEY` is set in your environment variables.\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 poetry run did-stuff show-config\n ```\n\n### Installing to a Repository\n\nTo install Did Stuff in a Git repository:\n\n```bash\npoetry run did-stuff install [path]\n```\n\nIf no path is specified, it uses the current directory. This installs the prepare-commit-msg hook in the specified Git repository.\n\n## Usage\n\nOnce installed in a repository, Did Stuff works automatically:\n\n1. Code your changes\n2. Stage your changes: `git add .`\n3. Commit: `git commit`\n\nDid Stuff will generate an AI-powered commit message for you to review and edit if needed.\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## Testing (because we're professionals)\n\nRun `pytest` and cross your fingers.\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. Make your changes\n5. Write or update tests\n6. Run the test suite\n7. Commit your changes with a clear message (or better yet, dogfood it with this tool)\n8. Push your branch: `git push origin your-branch-name`\n9. Open a pull request\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\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "AI-powered Git commit message generator",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"git",
" commit",
" message",
" generator",
" ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d084bfd7617a91a41e18d5b61b1b385ea41269d80ff806314f16d1a2361a9e74",
"md5": "1f86593f6110889cded16c4b1a31cdf5",
"sha256": "5ad5a4e35002574c249ae9c1c96d982834a4a9d3a7f19387c173a3e82c5bbc16"
},
"downloads": -1,
"filename": "did_stuff-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f86593f6110889cded16c4b1a31cdf5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 11263,
"upload_time": "2024-09-14T00:07:10",
"upload_time_iso_8601": "2024-09-14T00:07:10.870214Z",
"url": "https://files.pythonhosted.org/packages/d0/84/bfd7617a91a41e18d5b61b1b385ea41269d80ff806314f16d1a2361a9e74/did_stuff-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8de893d43878d7aefd966809a83cd24e86b236716be7ac5a8529982ec6fad6b",
"md5": "bb1fbee1a828b835637c17f00070f788",
"sha256": "57094ca86501b25804a7c383da90020113ee051326f30492e031cb355bd3a690"
},
"downloads": -1,
"filename": "did_stuff-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "bb1fbee1a828b835637c17f00070f788",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 11872,
"upload_time": "2024-09-14T00:07:12",
"upload_time_iso_8601": "2024-09-14T00:07:12.462953Z",
"url": "https://files.pythonhosted.org/packages/b8/de/893d43878d7aefd966809a83cd24e86b236716be7ac5a8529982ec6fad6b/did_stuff-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-14 00:07:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "did-stuff"
}
JSON