🛠 Commit simple boilerplate

Makefile

@@ -0,0 +1,24 @@
+.PHONY: clean-pyc
+
+default: test
+
+clean-pyc:
+	@find . -iname '*.py[co]' -delete
+	@find . -iname '__pycache__' -delete
+
+clean-dist:
+	@rm -rf dist/
+	@rm -rf build/
+	@rm -rf *.egg-info
+
+clean: clean-pyc clean-dist
+
+test:
+	pytest -vvv
+
+dist: clean
+	python3 setup.py sdist
+	python3 setup.py bdist_wheel
+
+version: dist
+	python3 setup.py --version

README.md

@@ -1,2 +1,41 @@
-# python3_CLI_boilerplate
+# Awesome Python CLI Boilerplate
-A quick boilerplate for CLI apps/scripts in Python3
+
+A quick boilerplate when creating a new CLI apps/scripts in Python3.
+
+### Install
+
+Create and source a virtual environment:
+
+```
+virtualenv venv
+source venv/bin/activate
+```
+
+Install dependencies:
+
+```
+pip3 install -r requirements.txt
+```
+
+Install package:
+
+```
+pip install .
+```
+
+Test your install with:
+
+```
+yourapp --help
+```
+
+
+--- 
+
+### Development
+
+Create a virtual environment and install the package with an editable option:
+
+```
+pip install --editable .
+```

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+norecursedirs = venv* .*
+addopts =
+    -r fEsxXw
+    -vvv

requirements.txt

@@ -0,0 +1 @@
+Click==7.0

setup.py

@@ -0,0 +1,16 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='yourapp',
+    version='0.0.1',
+    packages=find_packages(),
+    include_package_data=True,
+    author='Mia von Steinkirch',
+    install_requires=[
+        'Click',
+    ],
+    entry_points='''
+        [console_scripts]
+        yourapp=yourapp.yourapp:main
+    ''',
+)

tests/__init__.py

@@ -0,0 +1 @@
+#!/usr/bin/env python3

yourapp/__init__.py

@@ -0,0 +1 @@
+#!/usr/bin/env python3

yourapp/yourapp.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+
+import os
+import re
+import click
+
+
+@click.command()
+
+@click.option('-s', 
+            '--source', 
+            default='dev', 
+            nargs=1, 
+            show_default=True, 
+            help='Some source string.')
+
+@click.option('-t', 
+            '--target', 
+            default='staging', 
+            nargs=1, 
+            show_default=True, 
+            help='Some target string.')
+
+@click.option('-p', 
+            '--services', 
+            required=True)
+
+
+def main(source, target, services):
+    print(source, target, services)
+
+
+if __name__ == "__main__":
+    main(source, target, services)