Skip to content

Latest commit

 

History

History
128 lines (80 loc) · 3.05 KB

readme.md

File metadata and controls

128 lines (80 loc) · 3.05 KB
Raw

Git Commmit Cli

This project provides a cli to make git commits with a minimized odoo format from a text wizard.

Checkit out on pypi.

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.

cp ~/.commitclirc .commitclirc

Installation

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

commitcli

Example

Odoo (default)

ejemplo de imagen

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 /<type "ej fix">/

Formats

  • conventional commits CC
  • semantic git commit SGC
  • odoo tags Odoo

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