From 89927db8901c9e98d83ccdb61f8a8cbd348ed8ce Mon Sep 17 00:00:00 2001 From: Brennen Bearnes Date: Tue, 3 Jul 2018 11:04:29 -0600 Subject: [PATCH] add setup.py, add pypi to .travis.yml, misc. tweaks for pypi Per instructions at: https://github.com/adafruit/circuitpython/issues/979 --- .travis.yml | 41 ++++++++++++++++++--------------- docs/conf.py | 7 ------ requirements.txt | 3 ++- setup.py | 60 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 84 insertions(+), 27 deletions(-) create mode 100644 setup.py diff --git a/.travis.yml b/.travis.yml index d25ac38..2eff5de 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,26 +7,29 @@ dist: trusty sudo: false language: python python: - - "3.6" - +- '3.6' cache: - pip: true - + pip: true deploy: - provider: releases - api_key: $GITHUB_TOKEN - file_glob: true - file: $TRAVIS_BUILD_DIR/bundles/* - skip_cleanup: true - overwrite: true - on: - tags: true - + - provider: releases + api_key: "$GITHUB_TOKEN" + file_glob: true + file: "$TRAVIS_BUILD_DIR/bundles/*" + skip_cleanup: true + overwrite: true + on: + tags: true + - provider: pypi + user: adafruit-travis + on: + tags: true + password: + secure: 3in/QXIrXq6l2QJRYjUnufB6rYnZVptU9VeKsWsLSLty3BYnxbN8PEXWDu1h0q7W1s/aHcMrB25yZTRXnwAvYxrOsmA6ZYmmIX2CcT/bKbNWE+kKwl90BA48Ip8Awxc/jZOJ/gDCtbqE9mf8AFVd5zXzJUbgE8p6FSCurJLkJevBkWUcLws1KKEN0+kMu5+z8Ghi/HPacQ0Uvr2fNvSbGI0/hmPlJfZuhdp1zdo3R5cS2E4IiIO6UPDUINVMzQOBKcngZ14NIGUjSqaff1aP4elxY7qAndl3qMgoLq0EfVpxy2trsTvtSkpTqfSZamMZiZWF0T/oD7RkOllf2j3F6b37ZTZWhldZuLzDApLFy1aVVEme+yoPnWNPbYaREUkyhSmeA2bOAsoN7Mn5NG9HZOujrS/m5sJi8PKyRjbKgryt5uRrkKpPdJW8gUun5CoPEtNEQ6NT3vfI7DhjkiTevVxXkDHf0ENNtmhbla/3fYOB2jkJDYLOMyw2UTdn232ORlVHF0vVVjUZfJxrIUIb8L8XZ/dxXikORsY3Z0HYD8t6GDoAmvLr7LMw1pv3XxW6eV14Hc9SXoZdWwYTHYPQtT899pBrc7TqtLHh8OoQxMSFSfdiH7jfjkKB2VFUV7TNysxjg94ip9dC4R1tS49UHurP8CIBeMOyXFmlgiql5xU= install: - - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme - +- pip install -r requirements.txt +- pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme script: - - pylint adafruit_am2320.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-am2320 --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_am2320.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-am2320 --library_location . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/docs/conf.py b/docs/conf.py index 38b7d2c..e45be40 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,13 +16,6 @@ extensions = [ 'sphinx.ext.todo', ] -# TODO: Please Read! -# Uncomment the below if you use native CircuitPython modules such as -# digitalio, micropython and busio. List the modules you use. Without it, the -# autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["adafruit_bus_device", "micropython"] - - intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} # Add any paths that contain templates here, relative to this directory. diff --git a/requirements.txt b/requirements.txt index c47d35a..3031961 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ -adafruit-circuitpython-bus-device +Adafruit-Blinka +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..81fa1f7 --- /dev/null +++ b/setup.py @@ -0,0 +1,60 @@ +"""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-am2320', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython driver for the AM2320 temperature and humidity sensor.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_AM2320', + + # 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 am2320 temperature humidity 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_am2320'], +)