-# {{TITLE}}
+# Enviro pHAT Plus
-[![Build Status](https://travis-ci.com/pimoroni/{{LIBNAME}}-python.svg?branch=master)](https://travis-ci.com/pimoroni/{{LIBNAME}}-python)
-[![Coverage Status](https://coveralls.io/repos/github/pimoroni/{{LIBNAME}}-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/{{LIBNAME}}-python?branch=master)
-[![PyPi Package](https://img.shields.io/pypi/v/{{LIBNAME}}.svg)](https://pypi.python.org/pypi/{{LIBNAME}})
-[![Python Versions](https://img.shields.io/pypi/pyversions/{{LIBNAME}}.svg)](https://pypi.python.org/pypi/{{LIBNAME}})
+[![Build Status](https://travis-ci.com/pimoroni/envirophatplus-python.svg?branch=master)](https://travis-ci.com/pimoroni/envirophatplus-python)
+[![Coverage Status](https://coveralls.io/repos/github/pimoroni/envirophatplus-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/envirophatplus-python?branch=master)
+[![PyPi Package](https://img.shields.io/pypi/v/envirophatplus.svg)](https://pypi.python.org/pypi/envirophatplus)
+[![Python Versions](https://img.shields.io/pypi/pyversions/envirophatplus.svg)](https://pypi.python.org/pypi/envirophatplus)
# Installing
Stable library from PyPi:
-* Just run `sudo pip install {{LIBNAME}}`
+* Just run `sudo pip install envirophatplus`
Latest/development library from GitHub:
-* `git clone https://github.com/pimoroni/{{LIBNAME}}-python`
-* `cd {{LIBNAME}}-python`
+* `git clone https://github.com/pimoroni/envirophatplus-python`
+* `cd envirophatplus-python`
* `sudo ./install.sh`
+++ /dev/null
-* Python Library - library/name/__init__.py
-* At least *one* test - library/tests/test_setup.py
-* Examples
-
-# In Detail
-
-To get started, copy the contents of this repository (excluding the .git directory) and run `_bootstrap.sh` to highlight substitutions you need to make.
-
-Be careful to copy *all* files, including those starting with a . such as `.travis.yml`.
-
-A Makefile is provided to automate some tests, checks and package building. You should use it!
-
-## Library
-
-### Structure
-
-Libraries should be singleton if they pertain to a HAT or pHAT and class-based if they are for breakouts with selectable addresses.
-
-A singleton library would work like this:
-
-```
-import library
-
-library.do_something()
-```
-
-Whereas a class-based library requires an instance of its class:
-
-```
-import library
-
-device = library.Library()
-
-device.do_something()
-```
-
-### Linting
-
-You should ensure you either run `flake8` while writing the library, or use an IDE/Editor with linting.
-
-All libraries (and example code) should stick to PEP8 style guides, although you can ignore long line warnings (E501) if you feel they're unwarranted.
-
-### Testing
-
-At least one test script should be used to prevent obvious errors and omissions from creeping into the library.
-
-You should use `tox` to run the test scripts:
-
-```
-sudo pip install tox
-cd library/
-tox
-```
-
-## Examples
-
-Examples should use hyphens and short, descriptive names, ie: `rainbow-larson.py`
-
-Examples should include a `print()` front-matter introducing them, ie:
-
-```
-print("""rainbow-larson.py - Display a larson scanning rainbow
-
-Press Ctrl+C to exit.
-
-""")
-```
-
-# Deployment
-
-Before deploying you should `make python-testdeploy` and verify that the package looks good and is installable from test PyPi.
-
-You should also `make check` to catch common errors, including mismatched version numbers, trailing whitespace and DOS line-endings.
-
-Subsequent to deployment you should `git tag -a "vX.X.X" -m "Version X.X.X"` and `git push origin master --follow-tags` to tag a release on GitHub that matches the deployed code.
+++ /dev/null
-printf "\nOutstanding substitutions:\n"
-grep -Irn --color "{{[A-Z:]*}}"
-
-printf "\nOutstanding directory renames:\n"
-find . -regex ".*{{[A-Z]*}}"
+++ /dev/null
-git remote rename origin boilerplate
-git remote set-url --push boilerplate no_push
-git remote add origin $1
[run]
-source = {{LIBNAME}}
+source = envirophatplus
omit =
.tox/*
include LICENSE.txt
include README.rst
include setup.py
-recursive-include {{LIBNAME}} *.py
+recursive-include envirophatplus *.py
--- /dev/null
+Enviro pHAT Plus
+================
+
+|Build Status| |Coverage Status| |PyPi Package| |Python Versions|
+
+Installing
+==========
+
+Stable library from PyPi:
+
+- Just run ``sudo pip install envirophatplus``
+
+Latest/development library from GitHub:
+
+- ``git clone https://github.com/pimoroni/envirophatplus-python``
+- ``cd envirophatplus-python``
+- ``sudo ./install.sh``
+
+.. |Build Status| image:: https://travis-ci.com/pimoroni/envirophatplus-python.svg?branch=master
+ :target: https://travis-ci.com/pimoroni/envirophatplus-python
+.. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/envirophatplus-python/badge.svg?branch=master
+ :target: https://coveralls.io/github/pimoroni/envirophatplus-python?branch=master
+.. |PyPi Package| image:: https://img.shields.io/pypi/v/envirophatplus.svg
+ :target: https://pypi.python.org/pypi/envirophatplus
+.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/envirophatplus.svg
+ :target: https://pypi.python.org/pypi/envirophatplus
'Topic :: System :: Hardware']
setup(
- name='{{LIBNAME}}',
+ name='envirophatplus',
version='0.0.1',
author='Philip Howard',
author_email='phil@pimoroni.com',
- description="""{{DESCRIPTION}}""",
+ description="""Enviro pHAT Plus environmental monitoring add-on for Raspberry Pi""",
long_description=open('README.rst').read() + '\n' + open('CHANGELOG.txt').read(),
license='MIT',
keywords='Raspberry Pi',
url='http://www.pimoroni.com',
- project_urls={'GitHub': 'https://www.github.com/pimoroni/{{LIBNAME}}-python'},
+ project_urls={'GitHub': 'https://www.github.com/pimoroni/envirophatplus-python'},
classifiers=classifiers,
- packages=['{{LIBNAME}}'],
- install_requires=[]
+ packages=['envirophatplus'],
+ install_requires=['pms5003', 'ltr559', 'st7735']
)