From b8a3820f04e62001157fa7ee7397e9c3cd6923c7 Mon Sep 17 00:00:00 2001 From: marco-gallegos Date: Mon, 18 Jan 2021 14:54:21 -0600 Subject: [PATCH] chore(readme,setup): some updates for the new version some updates on the readme for the new version and also is updated the tags for the new version --- readme.md | 24 ++++++++++++++++++------ requirements.in | 3 ++- requirements.txt | 2 ++ setup.py | 5 +++-- 4 files changed, 25 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index 33ad5e7..14a3a6f 100644 --- a/readme.md +++ b/readme.md @@ -4,7 +4,13 @@ This project provides a cli to make git commits with a minimized [odoo format](h 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 nvim and vim editor +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) ## Instalation @@ -37,16 +43,25 @@ comitcli ![ejemplo de imagen](./static/img/example.png) +## 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 #### Formats -- [ ] config manager using ~/.comirclirc file -- [ ] conventional commits [CC](https://www.conventionalcommits.org/en/v1.0.0/) +- [*] config manager using ~/.comirclirc file +- [*] conventional commits [CC](https://www.conventionalcommits.org/en/v1.0.0/) - [tags](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) - [ ] semantic git commit [SGC](https://www.npmjs.com/package/semantic-git-commit-cli) - [ ] full odoo tags +- [ ] configuration changes using the cli ## Development @@ -59,9 +74,6 @@ using without install from the source python -m commitcli -and defining the __main__.py file - - ## References https://magmax.org/python-inquirer/ diff --git a/requirements.in b/requirements.in index 5836228..10c9d9b 100644 --- a/requirements.in +++ b/requirements.in @@ -1 +1,2 @@ -inquirer \ No newline at end of file +inquirer +click \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index ae8ed7a..ea78a56 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,6 +6,8 @@ # blessed==1.17.6 # via inquirer +click==7.1.2 + # via -r requirements.in inquirer==2.7.0 # via -r requirements.in python-editor==1.0.4 diff --git a/setup.py b/setup.py index ab08e1b..a8e3d1b 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,7 @@ """ @Author Marco A. Gallegos @Date 2020/12/31 -@update 2020/12/31 +@update 2021/01/18 @Description archivo que describe el paquete distribuible """ @@ -12,7 +12,7 @@ setuptools.setup( name="commitcli", - version="1.0.0", + version="1.1.0", author="Marco A. Gallegos", author_email="ma_galeza@hotmail.com", description="commit cli for git with some formats, by default short version of odoo format", @@ -30,6 +30,7 @@ python_requires='>=3.6', install_requires=[ 'inquirer', + 'click' ], # hacer que setup tools genere un comando cli entry_points={