python package template

Author: shlomi_h

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision History
+
+## 0.0.0 (YYYY/MM/DD)
+
+ - TBD

CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# For Contributors
+
+## Setup
+
+### Requirements
+
+* Make:
+    * Windows: http://mingw.org/download/installer
+    * Mac: http://developer.apple.com/xcode
+    * Linux: http://www.gnu.org/software/make
+* pipenv: http://docs.pipenv.org
+* Graphviz: http://www.graphviz.org/Download.php
+
+To confirm these system dependencies are configured correctly:
+
+```sh
+$ make doctor
+```
+
+### Installation
+
+Install project dependencies into a virtual environment:
+
+```sh
+$ make install
+```
+
+## Development Tasks
+
+### Testing
+
+Manually run the tests:
+
+```sh
+$ make test
+```
+
+or keep them running on change:
+
+```sh
+$ make watch
+```
+
+> In order to have OS X notifications, `brew install terminal-notifier`.
+
+### Documentation
+
+Build the documentation:
+
+```sh
+$ make docs
+```
+
+### Static Analysis
+
+Run linters and static analyzers:
+
+```sh
+$ make pylint
+$ make pycodestyle
+$ make pydocstyle
+$ make check  # includes all checks
+```
+
+## Continuous Integration
+
+The CI server will report overall build status:
+
+```sh
+$ make ci
+```
+
+## Release Tasks
+
+Release to PyPI:
+
+```sh
+$ make upload
+```

LICENSE.md

@@ -0,0 +1,21 @@
+**The MIT License (MIT)**
+
+Copyright © 2018, Shlomi Hod
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,4 @@
+include *.rst *.txt *.md
+recursive-include docs *.rst *.txt *.md
+graft */files
+graft */*/files

Makefile

@@ -0,0 +1,223 @@
+# Project settings
+PROJECT := ethically
+PACKAGE := ethically
+REPOSITORY := shlomihod/ethically
+
+# Project paths
+PACKAGES := $(PACKAGE) tests
+CONFIG := $(wildcard *.py)
+MODULES := $(wildcard $(PACKAGE)/*.py)
+
+# Virtual environment paths
+export PIPENV_VENV_IN_PROJECT=true
+export PIPENV_IGNORE_VIRTUALENVS=true
+VENV := .venv
+
+# MAIN TASKS ##################################################################
+
+SNIFFER := pipenv run sniffer
+
+.PHONY: all
+all: install
+
+.PHONY: ci
+ci: check test ## Run all tasks that determine CI status
+
+.PHONY: watch
+watch: install .clean-test ## Continuously run all CI tasks when files chanage
+	$(SNIFFER)
+
+.PHONY: run ## Start the program
+run: install
+	pipenv run python $(PACKAGE)/__main__.py
+
+# SYSTEM DEPENDENCIES #########################################################
+
+.PHONY: doctor
+doctor:  ## Confirm system dependencies are available
+	bin/verchew
+
+# PROJECT DEPENDENCIES ########################################################
+
+DEPENDENCIES = $(VENV)/.pipenv-$(shell bin/checksum Pipfile* setup.py)
+
+.PHONY: install
+install: $(DEPENDENCIES)
+
+$(DEPENDENCIES):
+	pipenv run python setup.py develop
+	pipenv install --dev
+	@ touch $@
+
+# CHECKS ######################################################################
+
+ISORT := pipenv run isort
+PYLINT := pipenv run pylint
+PYCODESTYLE := pipenv run pycodestyle
+PYDOCSTYLE := pipenv run pydocstyle
+
+.PHONY: check
+check: isort pylint pycodestyle pydocstyle ## Run linters and static analysis
+
+.PHONY: isort
+isort: install
+	$(ISORT) $(PACKAGES) $(CONFIG) --recursive --apply
+
+.PHONY: pylint
+pylint: install
+	$(PYLINT) $(PACKAGES) $(CONFIG) --rcfile=.pylint.ini
+
+.PHONY: pycodestyle
+pycodestyle: install
+	$(PYCODESTYLE) $(PACKAGES) $(CONFIG) --config=.pycodestyle.ini
+
+.PHONY: pydocstyle
+pydocstyle: install
+	$(PYDOCSTYLE) $(PACKAGES) $(CONFIG)
+
+# TESTS #######################################################################
+
+PYTEST := pipenv run py.test
+COVERAGE := pipenv run coverage
+COVERAGE_SPACE := pipenv run coverage.space
+
+RANDOM_SEED ?= $(shell date +%s)
+FAILURES := .cache/v/cache/lastfailed
+
+PYTEST_OPTIONS := --random --random-seed=$(RANDOM_SEED)
+ifdef DISABLE_COVERAGE
+PYTEST_OPTIONS += --no-cov --disable-warnings
+endif
+PYTEST_RERUN_OPTIONS := --last-failed --exitfirst
+
+.PHONY: test
+test: test-all ## Run unit and integration tests
+
+.PHONY: test-unit
+test-unit: install
+	@ ( mv $(FAILURES) $(FAILURES).bak || true ) > /dev/null 2>&1
+	$(PYTEST) $(PACKAGE) $(PYTEST_OPTIONS)
+	@ ( mv $(FAILURES).bak $(FAILURES) || true ) > /dev/null 2>&1
+	$(COVERAGE_SPACE) $(REPOSITORY) unit
+
+.PHONY: test-int
+test-int: install
+	@ if test -e $(FAILURES); then $(PYTEST) tests $(PYTEST_RERUN_OPTIONS); fi
+	@ rm -rf $(FAILURES)
+	$(PYTEST) tests $(PYTEST_OPTIONS)
+	$(COVERAGE_SPACE) $(REPOSITORY) integration
+
+.PHONY: test-all
+test-all: install
+	@ if test -e $(FAILURES); then $(PYTEST) $(PACKAGES) $(PYTEST_RERUN_OPTIONS); fi
+	@ rm -rf $(FAILURES)
+	$(PYTEST) $(PACKAGES) $(PYTEST_OPTIONS)
+	$(COVERAGE_SPACE) $(REPOSITORY) overall
+
+.PHONY: read-coverage
+read-coverage:
+	bin/open htmlcov/index.html
+
+# DOCUMENTATION ###############################################################
+
+PYREVERSE := pipenv run pyreverse
+MKDOCS := pipenv run mkdocs
+
+MKDOCS_INDEX := site/index.html
+
+.PHONY: docs
+docs: uml mkdocs ## Generate documentation
+
+.PHONY: uml
+uml: install docs/*.png
+docs/*.png: $(MODULES)
+	$(PYREVERSE) $(PACKAGE) -p $(PACKAGE) -a 1 -f ALL -o png --ignore tests
+	- mv -f classes_$(PACKAGE).png docs/classes.png
+	- mv -f packages_$(PACKAGE).png docs/packages.png
+
+.PHONY: mkdocs
+mkdocs: install $(MKDOCS_INDEX)
+$(MKDOCS_INDEX): mkdocs.yml docs/*.md
+	ln -sf `realpath README.md --relative-to=docs` docs/index.md
+	ln -sf `realpath CHANGELOG.md --relative-to=docs/about` docs/about/changelog.md
+	ln -sf `realpath CONTRIBUTING.md --relative-to=docs/about` docs/about/contributing.md
+	ln -sf `realpath LICENSE.md --relative-to=docs/about` docs/about/license.md
+	$(MKDOCS) build --clean --strict
+
+.PHONY: mkdocs-live
+mkdocs-live: mkdocs
+	eval "sleep 3; bin/open http://127.0.0.1:8000" &
+	$(MKDOCS) serve
+
+# BUILD #######################################################################
+
+PYINSTALLER := pipenv run pyinstaller
+PYINSTALLER_MAKESPEC := pipenv run pyi-makespec
+
+DIST_FILES := dist/*.tar.gz dist/*.whl
+EXE_FILES := dist/$(PROJECT).*
+
+.PHONY: build
+build: dist
+
+.PHONY: dist
+dist: install $(DIST_FILES)
+$(DIST_FILES): $(MODULES)
+	rm -f $(DIST_FILES)
+	pipenv run python setup.py check --strict --metadata
+	pipenv run python setup.py sdist
+	pipenv run python setup.py bdist_wheel
+
+.PHONY: exe
+exe: install $(EXE_FILES)
+$(EXE_FILES): $(MODULES) $(PROJECT).spec
+	# For framework/shared support: https://github.com/yyuu/pyenv/wiki
+	$(PYINSTALLER) $(PROJECT).spec --noconfirm --clean
+
+$(PROJECT).spec:
+	$(PYINSTALLER_MAKESPEC) $(PACKAGE)/__main__.py --onefile --windowed --name=$(PROJECT)
+
+# RELEASE #####################################################################
+
+TWINE := pipenv run twine
+
+.PHONY: upload
+upload: dist ## Upload the current version to PyPI
+	git diff --name-only --exit-code
+	$(TWINE) upload dist/*.*
+	bin/open https://pypi.org/project/$(PROJECT)
+
+# CLEANUP #####################################################################
+
+.PHONY: clean
+clean: .clean-build .clean-docs .clean-test .clean-install ## Delete all generated and temporary files
+
+.PHONY: clean-all
+clean-all: clean
+	rm -rf $(VENV)
+
+.PHONY: .clean-install
+.clean-install:
+	find $(PACKAGES) -name '*.pyc' -delete
+	find $(PACKAGES) -name '__pycache__' -delete
+	rm -rf *.egg-info
+
+.PHONY: .clean-test
+.clean-test:
+	rm -rf .cache .pytest .coverage htmlcov xmlreport
+
+.PHONY: .clean-docs
+.clean-docs:
+	rm -rf *.rst docs/apidocs *.html docs/*.png site
+
+.PHONY: .clean-build
+.clean-build:
+	rm -rf *.spec dist build
+
+# HELP ########################################################################
+
+.PHONY: help
+help: all
+	@ grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.DEFAULT_GOAL := help

Pipfile

@@ -0,0 +1,46 @@
+[[source]]
+
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[requires]
+
+python_version = "3.6"
+
+[dev-packages]
+
+# Linters
+isort = "*"
+pylint = "*"
+pycodestyle = "*"
+pydocstyle = "*"
+
+# Testing
+pytest = "~= 3.3"
+pytest-describe = "*"
+pytest-expecter = "*"
+pytest-random = "*"
+pytest-cov = "*"
+freezegun = "*"
+
+# Reports
+coverage-space = "*"
+
+# Documentation
+mkdocs = "*"
+docutils = "*"
+pygments = "*"
+
+# Build
+wheel = "*"
+pyinstaller = "*"
+
+# Release
+setuptools = ">= 38.6.0"
+twine = ">= 1.11.0"
+
+# Tooling
+sniffer = "*"
+MacFSEvents = { version = "*", sys_platform = "== 'darwin'" }
+pync = { version = "*", sys_platform = "== 'darwin'" }