# Git Commmit Cli
This project provides a cli to make git commits with a minimized [odoo format](https://www.odoo.com/documentation/14.0/reference/guidelines.html#git) from a text wizard.
Checkit out on [pypi](https://pypi.org/project/commitcli/).
Is a wrapper of the `git commit -m` command writed with 💟 on Python.
This was tested on a raspbian and a fedora OS with the nano, nvim and vim editor.
supported formats:
- short odoo
- conventional commits
- semantic git commits
- free (this is like use native `git commit` command)
## Features
### Commitcli configuration file per project
You can add a `.commitclirc` file in your project directory.
you can copy the global `.commitclirc` file to your project directory and edit it to use a diferent format.
```shell
cp ~/.commitclirc .commitclirc
```
## Installation
#### 1 - Install the package
note : use sudo if the local (user) python bin dir is not in the path
```shell
sudo pip install commitcli
```
example content of the `.commitclirc` file:
```shell
#Format for every commit
#supported formats free, odoo, sgc(semantic git commits) and cc (conventional commits)
format=odoo
#Option to sign the commits o every commit, must be True or False
signgpg=False
```
change this to use cc on your project:
```shell
#Format for every commit
#supported formats free, odoo, sgc(semantic git commits) and cc (conventional commits)
format=cc
#Option to sign the commits o every commit, must be True or False
signgpg=False
```
save this file and add to your git repository and every comand will use cc format on this project.
#### 2 - Enjoy
Add files to commit
```shell
git add .
```
Use the tool
```shell
commitcli
```
### Example
#### Odoo (default)
## Configuration
This utility creates a file into the users home directory `~/.commitclirc` in this file you will find some customizable options. the most important is the format option this option accepts this formats:
- odoo
- cc
- free
## Next Updates
- [ ] only make a echo of a format
- [ ] cli inline option to specify format (oddo, sgc, etc)
- [ ] module list to chose for context in cc or something like this `type(context)`
- [ ] quick templates
- clean up
- [ ] smarter
- store module list and provide a list of modules to choose from and the last by default
- [ ] create branches
- use format <username>/<type "ej fix">/<free name>
#### Formats
- [x] conventional commits [CC](https://www.conventionalcommits.org/en/v1.0.0/)
- [x] semantic git commit [SGC](https://www.npmjs.com/package/semantic-git-commit-cli)
- [x] odoo tags [Odoo](https://www.odoo.com/documentation/14.0/reference/guidelines.html#git)
## Development
## Help
using without install from the source
python -m commitcli
## References
https://magmax.org/python-inquirer/
https://python-packaging.readthedocs.io/en/latest/command-line-scripts.html
https://setuptools.readthedocs.io/en/latest/userguide/entry_point.html
https://medium.com/better-programming/python-click-building-your-first-command-line-interface-application-6947d5319ef7
Raw data
{
"_id": null,
"home_page": "https://github.com/marco-gallegos/commit-cli",
"name": "commitcli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "cli,cc,commit,git,odoo,github,gitlab,bitbucket,conventional commits,semantic commits",
"author": "Marco A. Gallegos",
"author_email": "ma_galeza@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/45/a6/ce3e8fc52130867d7a64e33bf17dda82c01dfff646220b301fcefa71ef97/commitcli-1.4.2.tar.gz",
"platform": null,
"description": "# Git Commmit Cli\n\nThis project provides a cli to make git commits with a minimized [odoo format](https://www.odoo.com/documentation/14.0/reference/guidelines.html#git) from a text wizard.\n\nCheckit out on [pypi](https://pypi.org/project/commitcli/).\n\nIs a wrapper of the `git commit -m` command writed with \ud83d\udc9f on Python.\n\nThis was tested on a raspbian and a fedora OS with the nano, nvim and vim editor.\n\nsupported formats:\n\n- short odoo\n- conventional commits\n- semantic git commits\n- free (this is like use native `git commit` command)\n\n## Features\n\n### Commitcli configuration file per project\n\nYou can add a `.commitclirc` file in your project directory.\n\nyou can copy the global `.commitclirc` file to your project directory and edit it to use a diferent format.\n\n```shell\ncp ~/.commitclirc .commitclirc\n```\n\n## Installation\n\n#### 1 - Install the package\n\nnote : use sudo if the local (user) python bin dir is not in the path\n\n```shell\nsudo pip install commitcli\n```\n\nexample content of the `.commitclirc` file:\n```shell\n#Format for every commit\n#supported formats free, odoo, sgc(semantic git commits) and cc (conventional commits)\nformat=odoo\n\n#Option to sign the commits o every commit, must be True or False\nsigngpg=False\n```\n\nchange this to use cc on your project:\n```shell\n#Format for every commit\n#supported formats free, odoo, sgc(semantic git commits) and cc (conventional commits)\nformat=cc\n\n#Option to sign the commits o every commit, must be True or False\nsigngpg=False\n```\n\nsave this file and add to your git repository and every comand will use cc format on this project.\n\n#### 2 - Enjoy\n\nAdd files to commit\n\n```shell\ngit add .\n```\n\n\nUse the tool\n\n```shell\ncommitcli\n```\n\n### Example\n\n#### Odoo (default)\n\n\n\n## Configuration\n\nThis utility creates a file into the users home directory `~/.commitclirc` in this file you will find some customizable options. the most important is the format option this option accepts this formats:\n\n- odoo\n- cc\n- free\n\n\n## Next Updates\n- [ ] only make a echo of a format\n- [ ] cli inline option to specify format (oddo, sgc, etc)\n- [ ] module list to chose for context in cc or something like this `type(context)`\n- [ ] quick templates\n - clean up\n- [ ] smarter\n - store module list and provide a list of modules to choose from and the last by default\n- [ ] create branches\n - use format <username>/<type \"ej fix\">/<free name> \n\n#### Formats\n\n- [x] conventional commits [CC](https://www.conventionalcommits.org/en/v1.0.0/) \n- [x] semantic git commit [SGC](https://www.npmjs.com/package/semantic-git-commit-cli)\n- [x] odoo tags [Odoo](https://www.odoo.com/documentation/14.0/reference/guidelines.html#git)\n\n\n## Development\n\n\n## Help\n\nusing without install from the source \n\npython -m commitcli\n\n\n## References\n\nhttps://magmax.org/python-inquirer/\n\nhttps://python-packaging.readthedocs.io/en/latest/command-line-scripts.html\n\nhttps://setuptools.readthedocs.io/en/latest/userguide/entry_point.html\n\nhttps://medium.com/better-programming/python-click-building-your-first-command-line-interface-application-6947d5319ef7\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "commit cli for git with some formats, by default short version of odoo format",
"version": "1.4.2",
"project_urls": {
"Homepage": "https://github.com/marco-gallegos/commit-cli"
},
"split_keywords": [
"cli",
"cc",
"commit",
"git",
"odoo",
"github",
"gitlab",
"bitbucket",
"conventional commits",
"semantic commits"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5d72fe4a6308f136a0a163a3055f7a2f5362f79c0aa8f4f0de53adf55072e1d",
"md5": "2404573fb11b02793bde4def352275f2",
"sha256": "aa887bbbf3c7db0fa1c34fe390f85f4e87cbdd4a197ca52f6a342db7301f295a"
},
"downloads": -1,
"filename": "commitcli-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2404573fb11b02793bde4def352275f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20186,
"upload_time": "2023-09-25T22:30:48",
"upload_time_iso_8601": "2023-09-25T22:30:48.122904Z",
"url": "https://files.pythonhosted.org/packages/a5/d7/2fe4a6308f136a0a163a3055f7a2f5362f79c0aa8f4f0de53adf55072e1d/commitcli-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "45a6ce3e8fc52130867d7a64e33bf17dda82c01dfff646220b301fcefa71ef97",
"md5": "b1e3591fec7ec5da233dbb1a1432def8",
"sha256": "8b61308352b5f70afbb62590ee996d48881d6e08a4f87fa23d194c80378531df"
},
"downloads": -1,
"filename": "commitcli-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "b1e3591fec7ec5da233dbb1a1432def8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17449,
"upload_time": "2023-09-25T22:30:49",
"upload_time_iso_8601": "2023-09-25T22:30:49.857177Z",
"url": "https://files.pythonhosted.org/packages/45/a6/ce3e8fc52130867d7a64e33bf17dda82c01dfff646220b301fcefa71ef97/commitcli-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 22:30:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "marco-gallegos",
"github_project": "commit-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "commitcli"
}
JSON
