merge(#47): implements pip-deploy

Changes leading to 3.0

Author: andre-filho

.gitignore

@@ -7,3 +7,6 @@ htmlcov/
 .coverage
 .pytest_cache/
 venv/
+*.egg-info/
+build/
+dist/

PREVIOUS_VERSIONS.md

@@ -0,0 +1,22 @@
+# Installing older versions
+
+## Versions
+
+### 2.0.3
+
+- https://github.com/andre-filho/commit-helper/releases/tag/2.0.3
+
+### 1.3.1
+
+- https://github.com/andre-filho/commit-helper/releases/tag/1.3.1
+
+## Install guide
+
+1. Make sure you have all dependencies installed:
+   - Git
+   - python3 and python3-pip
+2. Download and unzip the package of your choice
+3. Into the project's folder, run `pip install -r requirements.txt`. Note: `sudo` may be required
+4. Create a alias to executing the project: `echo "alias commit='python3 ~/.commit-helper/generator.py'" >> ~/.bashrc` might do it.
+5. Reload your terminal `source ~/.bashrc`
+6. Be happy

README.md

@@ -15,7 +15,7 @@
     <img src="https://api.codacy.com/project/badge/Grade/595af9a088cf44e19ec2679a8c2617f6" alt="Codacy Badge">
   </a>
   <a href="https://codeclimate.com/github/andre-filho/commit-helper/test_coverage"><img src="https://api.codeclimate.com/v1/badges/0ef7545d395120222d77/test_coverage" /></a>
-  
+
 </p>
 
 ## What does it do?
@@ -28,29 +28,10 @@ Sometimes we, the developers, go _full-loco_ while programming and make mistakes
 
 ## Installation
 
-Just follow the commands below:
+In order to install one of our older versions, check our [previous releases](PREVIOUS_VERSIONS). To install the latest (pip) version, just follow the commands below:
 
 ```bash
-  $ chmod +x $HOME/.commit-helper/install.sh
-
-  $ ./$HOME/.commit-helper/install.sh
-
-  # or you could type the commands below
-
-  # make sure you have the dependencies installed in your machine and
-  # have git ready to use
-  $ sudo apt install python3-pip git
-
-  # clone the repo into your home
-  $ git clone https://github.com/andre-filho/commit-helper.git ~/.commit-helper
-
-  $ pip3 install -r ~/.commit-helper/requirements.txt
-
-  # create a function in your .bashrc
-  $ echo "alias commit='python3 ~/.commit-helper/generator.py'" >> ~/.bashrc
-
-  # reload terminal
-  $ source ~/.bashrc
+$ pip3 install commit-helper  
 ```
 
 ## Usage and configuration
@@ -68,11 +49,11 @@ for the sake of not losing your precious time.
 
   optional arguments:
     -h, --help            show this help message and exit
-    --co-author CO_AUTHOR
+    -ca, --co-author CO_AUTHOR
                           make your friend an co-author to the commit
-    --no-generate NO_FILE
+    -nf, --no-file
                           disables the creation of a commiter.yml file
-    --convention {angular,changelog,symphony,message}
+    -c, --convention {angular,changelog,symphony,message}
                           Selects a convention to be used for the commit.
                           Required if there is no commiter.yml file.
 ```
@@ -96,6 +77,10 @@ convention: angular   # tag(context): commit message
 
 # or
 
+convention: karma   # tag(context): commit message
+
+# or
+
 convention: changelog # TAG: commit message
 
 # or

conventions/__init__.py renamed to commit_helper/__init__.py

@@ -1,27 +1,29 @@
-#! /usr/bin/env python3
-
 # dependencies imports
 from pathlib import Path
 from yaml import safe_load
 from yaml import YAMLError
 from os import system
 
 # conventions imports
-from conventions.karma_angular import angular_convention
-from conventions.changelog import changelog_convention
-from conventions.symphony_cmf import symphony_convention
-from conventions.no_convention import just_message
+from .conventions.karma_angular import angular_convention
+from .conventions.changelog import changelog_convention
+from .conventions.symphony_cmf import symphony_convention
+from .conventions.no_convention import just_message
 
 # utils imports
-from utils import parser_cli
-from utils import create_file
-from utils import debug
-from utils import get_text
-from utils import get_context
-from utils import gen_co_author
+from .utils.utils import parser_cli
+from .utils.utils import create_file
+from .utils.utils import debug
+from .utils.utils import get_text
+from .utils.utils import get_context
+from .utils.utils import gen_co_author
 
 
-def main(debug_mode=False):
+def main():
+    parser = parser_cli()
+    args = parser.parse_args()
+    debug_mode = args.debug
+    debug('args variable', args, debug_mode)
     file_path = Path('commiter.yml')
     debug('file_path', file_path, debug_mode)
     if file_path.is_file():
@@ -87,8 +89,5 @@ def main(debug_mode=False):
         parser.print_help()
 
 
-if __name__ == '__main__':
-    parser = parser_cli()
-    args = parser.parse_args()
-    debug('args variable', args, args.debug)
-    main(args.debug)
+#
+# main(args.debug)

generator.py renamed to commit_helper/__main__.py

@@ -1,22 +1,3 @@
 #! /bin/bash
 
-if [command -v git]; then
-  sudo apt-get update -qq;
-  sudo apt install git;
-fi
-
-if [command -v python3]; then
-  sudo apt install python3;
-fi
-
-if [command -v pip3]; then
-  sudo apt install python3-pip;
-fi
-
-git clone https://github.com/andre-filho/commit-helper.git ~/.commit-helper;
-
-pip3 install --user ~/.commit-helper/requirements.txt;
-
-chmod +x $HOME/.commit-helper/generator.py;
-
-echo "alias commit='./$HOME/.commit-helper/generator.py' >> $HOME/.bashrc;
+pip3 install -e .

commit_helper/conventions/__init__.py

@@ -0,0 +1,26 @@
+from setuptools import setup
+
+with open("README.md", 'r') as fi:
+    long_desc = fi.read()
+
+setup(  # pragma: no cover
+    name='commit-helper',
+    description="A python program that helps you write commits following commit conventions",  # nopep8
+    url='https://github.com/andre-filho/commit-helper',
+    long_description=long_desc,
+    long_description_content_type='text/markdown',
+    author='Andre de Sousa Costa Filho',
+    author_email='[email protected]',
+    version='3.0.1',
+    packages=['commit_helper'],
+    entry_points={
+        'console_scripts': [
+            'commit = commit_helper.__main__:main',
+            'commit-helper = commit_helper.__main__:main',
+        ]
+    },
+    install_requires=[
+        'pyyaml',
+        'argparse',
+    ],
+)

conventions/changelog.py renamed to commit_helper/conventions/changelog.py

@@ -1,7 +1,7 @@
-import conventions.karma_angular as angular
-import conventions.changelog as changelog
-import conventions.symphony_cmf as symphony
-import conventions.no_convention as no_convention
+import commit_helper.conventions.karma_angular as angular
+import commit_helper.conventions.changelog as changelog
+import commit_helper.conventions.symphony_cmf as symphony
+import commit_helper.conventions.no_convention as no_convention
 
 
 def test_angular_convention_with_context():

conventions/custom_convention_handler.py renamed to commit_helper/conventions/custom_convention_handler.py

@@ -1,4 +1,4 @@
-import utils
+import commit_helper.utils.utils as utils
 # import yaml
 
 
@@ -37,7 +37,7 @@ def test_sanitize_as_empty_string():
     string = utils.sanitize_as_empty_string(string)
     if not string == 'asopdfha':
         raise AssertionError()
-    
+
     string2 = None
     string2 = utils.sanitize_as_empty_string(string2)
     if not string2 == '':