Skip to content

Commit

Permalink
chore(readme,setup): some updates for the new version
Browse files Browse the repository at this point in the history
some updates on the readme for the new version and also is updated the tags for the new version
  • Loading branch information
marco-gallegos committed Jan 18, 2021
1 parent 6bfea50 commit b8a3820
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 9 deletions.
24 changes: 18 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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/
Expand Down
3 changes: 2 additions & 1 deletion requirements.in
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
inquirer
inquirer
click
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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
"""
Expand All @@ -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",
Expand All @@ -30,6 +30,7 @@
python_requires='>=3.6',
install_requires=[
'inquirer',
'click'
],
# hacer que setup tools genere un comando cli
entry_points={
Expand Down

0 comments on commit b8a3820

Please sign in to comment.