Synced with boilerplate-python

Author: Gadgetoid

.stickler.yml

@@ -0,0 +1,5 @@
+---
+linters:
+    flake8:
+        python: 3
+        max-line-length: 160

.travis.yml

@@ -11,8 +11,6 @@ matrix:
       env: TOXENV=py27
     - python: "3.5"
       env: TOXENV=py35
-    - python: "2.7"
-      env: TOXENV=py27
 
 install:
   - pip install --ignore-installed --upgrade setuptools pip tox coveralls
@@ -22,3 +20,6 @@ script:
   - tox -vv
 
 after_success: if [ "$TOXENV" == "py35" ]; then coveralls; fi
+
+notifications:
+  email: false

Makefile

@@ -1,20 +1,41 @@
+LIBRARY_VERSION=$(shell cat library/setup.py | grep version | awk -F"'" '{print $$2}')
+LIBRARY_NAME=$(shell cat library/setup.py | grep name | awk -F"'" '{print $$2}')
+
 .PHONY: usage install uninstall
 usage:
+	@echo "Library: ${LIBRARY_NAME}"
+	@echo "Version: ${LIBRARY_VERSION}\n"
 	@echo "Usage: make <target>, where target is one of:\n"
 	@echo "install:       install the library locally from source"
 	@echo "uninstall:     uninstall the local library"
+	@echo "check:         peform basic integrity checks on the codebase"
 	@echo "python-readme: generate library/README.rst from README.md"
 	@echo "python-wheels: build python .whl files for distribution"
 	@echo "python-sdist:  build python source distribution"
 	@echo "python-clean:  clean python build and dist directories"
-	@echo "python-dist:   build all python distribution files" 
+	@echo "python-dist:   build all python distribution files"
+	@echo "python-testdeploy: build all and deploy to test PyPi"
+	@echo "tag:           tag the repository with the current version"
 
 install:
 	./install.sh
 
 uninstall:
 	./uninstall.sh
 
+check:
+	@echo "Checking for trailing whitespace"
+	@! grep -IUrn --color "[[:blank:]]$$" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO
+	#@echo "Checking for DOS line-endings"
+	#@! grep -IUrn --color "" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile
+	@echo "Checking library/CHANGELOG.txt"
+	@cat library/CHANGELOG.txt | grep ^${LIBRARY_VERSION}
+	@echo "Checking library/${LIBRARY_NAME}/__init__.py"
+	@cat library/${LIBRARY_NAME}/__init__.py | grep "^__version__ = '${LIBRARY_VERSION}'"
+
+tag:
+	git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
+
 python-readme: library/README.rst
 
 python-license: library/LICENSE.txt
@@ -40,5 +61,8 @@ python-clean:
 python-dist: python-clean python-wheels python-sdist
 	ls library/dist
 
-python-deploy: python-dist
+python-testdeploy: python-dist
+	twine upload --repository-url https://test.pypi.org/legacy/ library/dist/*
+
+python-deploy: check python-dist
 	twine upload library/dist/*

install.sh

@@ -1,6 +1,9 @@
 #!/bin/bash
 
-printf "AS7262 Python Library: Installer\n\n"
+LIBRARY_VERSION=`cat library/setup.py | grep version | awk -F"'" '{print $2}'`
+LIBRARY_NAME=`cat library/setup.py | grep name | awk -F"'" '{print $2}'`
+
+printf "$LIBRARY_NAME $LIBRARY_VERSION Python Library: Installer\n\n"
 
 if [ $(id -u) -ne 0 ]; then
 	printf "Script must be run as root. Try 'sudo ./install.sh'\n"

library/as7262/__init__.py

@@ -6,6 +6,8 @@
 from i2cdevice import Device, Register, BitField, _int_to_bytes
 from i2cdevice.adapter import Adapter, LookupAdapter
 
+__version__ = '0.0.2'
+
 
 class as7262VirtualRegisterBus():
     """AS7262 Virtual Register.

library/setup.cfg

@@ -1,6 +1,10 @@
+[metadata]
+# This includes the license file(s) in the wheel.
+# https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file
+license_files = LICENSE.txt
+
 [flake8]
 exclude =
-	test.py
 	.tox,
 	.eggs,
 	.git,

library/setup.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 """
-Copyright (c) 2016 Pimoroni.
+Copyright (c) 2016 Pimoroni
 
 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
@@ -47,6 +47,7 @@
     license='MIT',
     keywords='Raspberry Pi',
     url='http://www.pimoroni.com',
+    project_urls={'GitHub': 'https://www.github.com/pimoroni/as7262-python'},
     classifiers=classifiers,
     packages=['as7262'],
     install_requires=['i2cdevice']

library/tox.ini

@@ -11,13 +11,14 @@ deps =
 	mock
 	pytest>=3.1
 	pytest-cov
- 
+
 [testenv:qa]
 commands =
+	check-manifest --ignore tox.ini,tests*,.coveragerc
+	python setup.py check -m -r -s
 	flake8 --ignore E501
 	rstcheck README.rst
 deps =
+	check-manifest
 	flake8
-	flake8-docstrings
-	flake8-quotes
 	rstcheck

uninstall.sh

@@ -1,8 +1,9 @@
 #!/bin/bash
 
-PACKAGE="as7262"
+LIBRARY_VERSION=`cat library/setup.py | grep version | awk -F"'" '{print $2}'`
+LIBRARY_NAME=`cat library/setup.py | grep name | awk -F"'" '{print $2}'`
 
-printf "AS7262 Python Library: Uninstaller\n\n"
+printf "$LIBRARY_NAME $LIBRARY_VERSION Python Library: Uninstaller\n\n"
 
 if [ $(id -u) -ne 0 ]; then
 	printf "Script must be run as root. Try 'sudo ./uninstall.sh'\n"
@@ -12,11 +13,11 @@ fi
 cd library
 
 printf "Unnstalling for Python 2..\n"
-pip uninstall $PACKAGE
+pip uninstall $LIBRARY_NAME
 
 if [ -f "/usr/bin/pip3" ]; then
 	printf "Uninstalling for Python 3..\n"
-	pip3 uninstall $PACKAGE
+	pip3 uninstall $LIBRARY_NAME
 fi
 
 cd ..