commit cli for git with some formats, by default short version of odoo format
Project description
Git Commmit Cli
This project provides a cli to make git commits with a minimized odoo format from a text wizard.
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
- 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.
cp ~/.commitclirc .commitclirc
Instalation
1 - Install the package
note : use sudo if the local (user) python bin dir is not in the path
sudo pip install commitcli
example content of the .commitclirc
file:
#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:
#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
git add .
Use the tool
comitcli
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
- local .comitclirc file to every project
- 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)
Formats
- config manager using ~/.comirclirc file
- conventional commits CC
- semantic git commit SGC
- full odoo tags
- configuration changes using the cli
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for commitcli-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69bbd3fce6a1786818cee3bc3a4d171752f41e7309469027a75beb83814d43dd |
|
MD5 | d2bf096a7d7d42b97cda888f1aeaaab5 |
|
BLAKE2b-256 | 9814e000d69e2f1093fbd3b7ecd6b65b4fdf8d692e61a47c82fc72e4ce1ded50 |