From 050f1cc97af30355d2b39b7df494e564346dc791 Mon Sep 17 00:00:00 2001 From: Brennen Bearnes Date: Tue, 3 Jul 2018 15:58:48 -0600 Subject: [PATCH] add setup.py, add pypi to .travis.yml, misc. tweaks for pypi, .gitignore Per instructions at: adafruit/circuitpython#979 --- .gitignore | 6 +++++ .travis.yml | 46 +++++++++++++++++----------------- docs/conf.py | 5 ---- requirements.txt | 3 ++- setup.py | 64 ++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 94 insertions(+), 30 deletions(-) create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index 0dd8629..cc1a9c8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,12 @@ +*.mpy +.idea __pycache__ _build *.pyc .env build* bundles +*.DS_Store +.eggs +dist +**/*.egg-info diff --git a/.travis.yml b/.travis.yml index 8135093..88063dc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,32 +1,30 @@ -# 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 - 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: E3o11ZLz+grfuk60uwZFz1tsFMyit5Uwd2cJKogHveuZDtJHASWJlmpLDmBR1wf2MCSNp4ERP/d9kAoGL4n8NQJiAprRoofSgmWaHWm4LIOWUyt0ZwPd64JgrdbHyCChgkCfvmdiwtxRS25Ttj016fhTJEnf1KJPscuxLdjZVZYBd3ItE5P3RBxJ2FVBRgpwFU4AaB+qNKNVuwsc5vMHniYtSjYE1wzY7JLNApzXc9P4Ss9KmlU1nz6oDB9iulEsWO1wC/S9SZpcv+i+N3iwR5eugRAeUgpF0aQ9CfQpAw4bTT1S+tibBUvvbSsFCaLCgMeRlAobJOsNGl3sBIlbBnSprm2qccY+76Pg4w7dW8Jo0Dd0RuRvM/E9Xe2edlXYoW8jZzaGsxRn2j59inn1jTDVKQIydT8Eg6YOVGJy4ZsYek7USosHpAmlHAu9m8j8ikHJ/nAdeKaxxQiJIRvDKAW1vvyN1zeuhF0Rn7k7CK/NfM32Pwf5MEgXJIQIqDpySRAR2AIRXRkEdssGZ82G+foTffSSZw6i3025sLx/NEOZNZAFB2k1cPSlmLFWPMgWOgE2/b8S36M/17mH0bRpvbCW0H4rYpHbWGgtPFKsGxzCxSO5Yu5d66pQaowINGgB9n8Oub8BZJlPixOyb32i9D/9zLMxUxlzEApWckEFfHc= install: - - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme - +- install -r requirements.txt +- pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme script: - - pylint adafruit_as726x.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-as726x --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_as726x.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-as726x --library_location . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/docs/conf.py b/docs/conf.py index 688aa53..11061b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,11 +15,6 @@ extensions = [ 'sphinx.ext.todo', ] -# 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 = ["digitalio", "busio", "adafruit_bus_device", "micropython", "ustruct"] - autodoc_member_order = 'bysource' intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} diff --git a/requirements.txt b/requirements.txt index 7053ecf..d5d88a1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ -adafruit-circuitpython-bus-device +Adafruit-Blinka +adafruit-circuitpython-busdevice adafruit-circuitpython-register diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..10d8d3f --- /dev/null +++ b/setup.py @@ -0,0 +1,64 @@ +"""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-as726x', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython driver for AS726x spectral sensor.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_AS726x', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka', + 'adafruit-circuitpython-register', + '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 as726x light sensor 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_as726x'], +)