PyPI setup.

This commit is contained in:
Kattni Rembor 2018-11-06 18:52:43 -05:00
parent 36436ee09e
commit 51637954a7
5 changed files with 113 additions and 23 deletions

6
.gitignore vendored
View file

@ -1,6 +1,12 @@
*.mpy
.idea
__pycache__
_build
*.pyc
.env
build*
bundles
*.DS_Store
.eggs
dist
**/*.egg-info

View file

@ -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
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: SUjp003EQBpvY62r3UkjOxHF15FPw7tlK1OMjS4dF8Y7PzG6KIhV9ugUHNiXpBVmTLNr6r4boApVasEVdrodB9Ybk5gsaapxlOfG9yl/p5N0fqqf1F+sDXZhASv1mJCLR/ALgWIXIgtdzwWxGrnFpe0J6sNOLg6plu1Gweca0zHXH0hgN4xItEc/Sn8fr2To9HIQVKI9wZPhNigN35JIAeOP62er+Ijeoc4vJOoof+CvKObgKZ/BFIcX7SLWFPeWRd4366t5sg0fL9iCuLHb75rM+3Uc0OMeM0mRLTLEAKDAj9N49Tk1AHai5JE7kkGfixWDG43UKpDhtdEfw1MIB58QQZ0KRItKVKAnL/TBPM3zN3ZYnBzhEE1fcWETg9Vz5UBeEPKcHxbx5DGz63Hl3ooHBuPRIn9NCzOSpo6PQpyDTKXjm5uZ3qISpbgBNymdFIkVJMg+ERcl3/3r1SZg0jkzOCaccBRaEuRur7Uv34gcjjlzIHWyrSf/PT/ygQo5di6yPy9+BnPzBQaZXe8XnNhbaLTZaeoPluI1ps6AWVVro+RwuZDG85llIQM1/iIy6R38GL5LlR2ioZiM1OMIIB81JAGA05UC0IqnZFXYdy02XfwyOUXK5ur+YlntG2fOm1uNcg/d6IBEW+FEJij9i6HeXyCquHts7G0WQK2s4rU=
install:
- 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_bmp3xx.py
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bmp3xx --library_location .
- cd docs && sphinx-build -E -W -b html . _build/html
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace
examples/*.py)
- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bmp3xx --library_location
.
- cd docs && sphinx-build -E -W -b html . _build/html && cd ..

View file

@ -1 +0,0 @@
# Adafruit_CircuitPython_BMP3XX

View file

@ -13,7 +13,7 @@ Introduction
:target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_BMP3XX
:alt: Build Status
CircuitPython driver from BMP3XX Temperature and Barometic Pressure sensor.
CircuitPython driver from BMP3XX Temperature and Barometric Pressure sensor.
Dependencies
=============
@ -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-bmp3xx/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-bmp3xx
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-bmp3xx
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-bmp3xx
Usage Example
=============

61
setup.py Normal file
View file

@ -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-bmp3xx',
use_scm_version=True,
setup_requires=['setuptools_scm'],
description='CircuitPython library for BMP3XX Temperature and Barometric Pressure sensor.',
long_description=long_description,
long_description_content_type='text/x-rst',
# The project's main homepage.
url='https://github.com/adafruit/Adafruit_CircuitPython_BMP3XX',
# Author details
author='Adafruit Industries',
author_email='circuitpython@adafruit.com',
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 temperature barometric pressure temp'
'bmp3xx bmp388 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_bmp3xx'],
)