# DevCommit
A command-line AI tool for autocommits.
## Features
- Automatic commit generation using AI.
- Easy integration with your Git workflow.
- Customizable options for commit messages.
## Installation
1. **Install DevCommit**
Run the following command to install DevCommit:
```bash
pip install devcommit
```
2. **Add the `.dcommit` Configuration File**
DevCommit uses a configuration file (`.dcommit`) to customize commit settings. Follow these steps to create it:
- **Option 1: Home Directory**
To set up DevCommit globally, create the `.dcommit` file in your home directory:
```bash
echo -e "LOCALE = en\nMAX_NO = 1\nCOMMIT_TYPE = conventional\nMODEL_NAME = gemini-1.5-flash" > ~/.dcommit
```
- **Option 2: Virtual Environment**
Alternatively, you can create the `.dcommit` file in your virtual environment’s `config` directory for environment-specific settings:
```bash
mkdir -p $VIRTUAL_ENV/config
echo -e "LOCALE = en\nMAX_NO = 1\nCOMMIT_TYPE = conventional\nMODEL_NAME = gemini-1.5-flash" > $VIRTUAL_ENV/config/.dcommit
```
## Usage
After installation, you can start using DevCommit directly in your terminal:
```bash
devcommit
```
Raw data
{
"_id": null,
"home_page": "https://github.com/hordunlarmy/DevCommit",
"name": "DevCommit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "HordunTech",
"author_email": "horduntech@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9d/74/2729eb4537490eaeafd0f6095c45e42f1d5d76a52ad7d78c4443591c4a2c/devcommit-0.1.4.3.tar.gz",
"platform": null,
"description": "# DevCommit\n\nA command-line AI tool for autocommits.\n\n## Features\n\n- Automatic commit generation using AI.\n- Easy integration with your Git workflow.\n- Customizable options for commit messages.\n\n\n\n## Installation\n\n1. **Install DevCommit** \n Run the following command to install DevCommit:\n\n ```bash\n pip install devcommit\n ```\n\n2. **Add the `.dcommit` Configuration File** \n DevCommit uses a configuration file (`.dcommit`) to customize commit settings. Follow these steps to create it:\n\n - **Option 1: Home Directory** \n To set up DevCommit globally, create the `.dcommit` file in your home directory:\n\n ```bash\n echo -e \"LOCALE = en\\nMAX_NO = 1\\nCOMMIT_TYPE = conventional\\nMODEL_NAME = gemini-1.5-flash\" > ~/.dcommit\n ```\n\n - **Option 2: Virtual Environment** \n Alternatively, you can create the `.dcommit` file in your virtual environment\u2019s `config` directory for environment-specific settings:\n\n ```bash\n mkdir -p $VIRTUAL_ENV/config\n echo -e \"LOCALE = en\\nMAX_NO = 1\\nCOMMIT_TYPE = conventional\\nMODEL_NAME = gemini-1.5-flash\" > $VIRTUAL_ENV/config/.dcommit\n ```\n\n## Usage\n\nAfter installation, you can start using DevCommit directly in your terminal:\n\n```bash\ndevcommit\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A command-line AI tool for autocommits",
"version": "0.1.4.3",
"project_urls": {
"Homepage": "https://github.com/hordunlarmy/DevCommit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "277a1e06ae84cbcf881f9bf19b8518fa01098390c64a6146a850beb6a3953bf8",
"md5": "2cdd3c87c0bb02fee553993e90099776",
"sha256": "abbfefe9ddc34f47fcf24967c38754c982b4cd5167277e61b5dcb09a4217cc4a"
},
"downloads": -1,
"filename": "DevCommit-0.1.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2cdd3c87c0bb02fee553993e90099776",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22098,
"upload_time": "2024-11-27T11:49:35",
"upload_time_iso_8601": "2024-11-27T11:49:35.695595Z",
"url": "https://files.pythonhosted.org/packages/27/7a/1e06ae84cbcf881f9bf19b8518fa01098390c64a6146a850beb6a3953bf8/DevCommit-0.1.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d742729eb4537490eaeafd0f6095c45e42f1d5d76a52ad7d78c4443591c4a2c",
"md5": "e69875c269d0e1503f6ad5e5b1311739",
"sha256": "95c83e90ea3123f3f7b1761c20e89b5d9d51c84d62fd0bca76429648dc20eb62"
},
"downloads": -1,
"filename": "devcommit-0.1.4.3.tar.gz",
"has_sig": false,
"md5_digest": "e69875c269d0e1503f6ad5e5b1311739",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20376,
"upload_time": "2024-11-27T11:49:36",
"upload_time_iso_8601": "2024-11-27T11:49:36.696796Z",
"url": "https://files.pythonhosted.org/packages/9d/74/2729eb4537490eaeafd0f6095c45e42f1d5d76a52ad7d78c4443591c4a2c/devcommit-0.1.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 11:49:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hordunlarmy",
"github_project": "DevCommit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "devcommit"
}
JSON
