Skip to content

Commit

Permalink
Merge pull request #2 from kattni/pypi
Browse files Browse the repository at this point in the history
PyPI setup.
  • Loading branch information
sommersoft authored Nov 12, 2018
2 parents 66c0559 + d381774 commit 6405c25
Show file tree
Hide file tree
Showing 4 changed files with 112 additions and 21 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
*.mpy
.idea
__pycache__
_build
*.pyc
.env
build*
bundles
*.DS_Store
.eggs
dist
**/*.egg-info
41 changes: 20 additions & 21 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,33 @@
# This is a common .travis.yml for generating library release zip files for
# CircuitPython library releases using circuitpython-build-tools.
# See https://github.com/adafruit/circuitpython-build-tools for detailed setup
# instructions.

dist: trusty
sudo: false
language: python
python:
- "3.6"

- '3.6'
cache:
pip: true

pip: true
deploy:
provider: releases
api_key: $GITHUB_TOKEN
- provider: releases
api_key: "$GITHUB_TOKEN"
file_glob: true
file: $TRAVIS_BUILD_DIR/bundles/*
file: "$TRAVIS_BUILD_DIR/bundles/*"
skip_cleanup: true
overwrite: true
on:
tags: true

- provider: pypi
user: adafruit-travis
on:
tags: true
password:
secure: O1envncCM5yPOJITHG6mcgN7XR4hYGvIE8mpJyb/okQnH40bd9CIvbbLcYqbjLNukhG4qD4wWpxcFEriO26jLaHxdnUbtC6IZze3J/dwerPDoRXsiF/IlJVdAcR5yD59PqkCW2D8NHYmnxxNSeLBQDy1UUzPN+bfszC3rv/5rnPuzaw+WvbXDJGLyS5Gbo3EIhDFoLA501bSpz6QnZ6yoYUjzeyd2vYFHpsj16nIGrDI7woL6oCz74iE/iHFre9d6dF9R6nsGlJ3+ut1CX+7pAnrgMw3GntZpPB8rL62BGjubf9ETmXRL+tNZ0SoI4oBD/hZMqgqQvYg1YDD9PUUrnpraW2iQmos+te7reYleCVB7eRiVa/YQFgBHyYSpeakzJMv7u9aItpIaBNaH0lZpGemn8qhz4JWfPh8Bg/qvOnTfBG0t66dtwGXhFFbSnEEmFZKTQE37gAfECYJEBiPGFtEyz8HqDuScvCYDI330WSi+c4ttK70Kim7klfX/otMZR4aicvAybqVTFKNDa6l4ZfqVF4x7jGafqI64KDGSzt19ZAb0oCP1QF8o1DcV3lLSTt14Ra0qZ9jJY96e60YLyS08GvsbPH3jfx2qbb3i3YwDl0iFmpEAHFLN5cikD31bd0vLMXYpL97PqU1zwVdJI4mkk6Sbt5uBeYRfJe5fik=
install:
- pip install -r requirements.txt
- pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
- pip install --force-reinstall pylint==1.9.2

- pip install -r requirements.txt
- pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
- pip install --force-reinstall pylint==1.9.2
script:
- pylint adafruit_mpl115a2.py
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-mpl115a2 --library_location .
- cd docs && sphinx-build -E -W -b html . _build/html
- pylint adafruit_mpl115a2.py
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace
examples/*.py)
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-mpl115a2 --library_location
.
- cd docs && sphinx-build -E -W -b html . _build/html && cd ..
25 changes: 25 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
--------------------

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-mpl115a2/>`_. To install for current user:

.. code-block:: shell
pip3 install adafruit-circuitpython-mpl115a2
To install system-wide (this may be required in some cases):

.. code-block:: shell
sudo pip3 install adafruit-circuitpython-mpl115a2
To install in a virtual environment in your current project:

.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-mpl115a2
Usage Example
=============

Expand Down
61 changes: 61 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
"""A setuptools based setup module.
See:
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject
"""

# Always prefer setuptools over distutils
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path

here = path.abspath(path.dirname(__file__))

# Get the long description from the README file
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()

setup(
name='adafruit-circuitpython-mpl115a2',

use_scm_version=True,
setup_requires=['setuptools_scm'],

description='CircuitPython driver for MPL115A2 I2C Barometric Pressure/Temperature Sensor.',
long_description=long_description,
long_description_content_type='text/x-rst',

# The project's main homepage.
url='https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2',

# Author details
author='Adafruit Industries',
author_email='[email protected]',

install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],

# Choose your license
license='MIT',

# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers=[
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'Topic :: Software Development :: Libraries',
'Topic :: System :: Hardware',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
],

# What does your project relate to?
keywords='adafruit i2c barometric pressure temperature '
'mpl115a2 hardware micropython circuitpython',

# You can just specify the packages manually here if your project is
# simple. Or you can use find_packages().
py_modules=['adafruit_mpl115a2'],
)

0 comments on commit 6405c25

Please sign in to comment.