From 8d62afb2ff13c55aff4feaf4d0479131e479acb2 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Thu, 18 Oct 2018 14:25:33 -0400 Subject: [PATCH 1/3] PyPi setup. --- .gitignore | 6 +++++ .travis.yml | 41 ++++++++++++++++---------------- docs/conf.py | 2 +- requirements.txt | 1 + setup.py | 61 ++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 89 insertions(+), 22 deletions(-) create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index 0dd8629..55f127b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,12 @@ +*.mpy +.idea __pycache__ _build *.pyc .env build* bundles +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index c301159..000eb9f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -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: 0kjpm+3P8V0jJbOrxAzqRsdlIBbyVMHgXXYolnkDJUSfyoX2iCaK4iyx3IabpBDz4yUPJAXr9nG+oMryRD3vdgZ+RmtcAS2cJlN1LiKrkE5IAQWQwjzcTS7GOmVXpJEstW1qvV1q/+6lKEi2TQ3JgXmA6AoAMZwIsix43QRjoS5xWKuU+1ZSrRPgs4ZrPdbs7BZ5N8IE7/mYRa8J06ICeLh/0jUU2VKKaqSvr5npeMt4kkEJlkFB4hWpCcoLY7yBOeGZ1wQgfJ38FFpFUvcamnRZVt+A3oEjUeznjQKFkRd84Ezu2ASzyiOmi5FPCP4L1dX8P2cOHgRB15vTqDcbUnb7AQnLoWMTMlU9CF0cRdw2DCvGqmWMuOgIrbNoqngMrvG7U53oz3x18QGaTL2q/GZZ0GInnDkftK18U2xbrmGGOxTft2mPMqvEZrGEFD6FsstFrqlN0vQhuQ1HuxxljOARLdXRaMVTvSJxwIMj56dPDZOK3uy0JGA11/VpT7mmORANgbQOCfdF9bHuLKlXqqVcinZ046pK8Y4nK842Dx1glkRtmXQ3hv6CbvFYDjrDlCjreQcnTtIX+euA1ejiWMR9zS4iU7EKQfgda1+N/a857XQ6g2OqwZsc+3j/HEqZz6NuppiS27duMse4NI1xnGDt7DBkmqWgWmG1wfJTOco= 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_max31856.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max31856 --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_max31856.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace + examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max31856 --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/docs/conf.py b/docs/conf.py index 6015916..0797129 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # 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", "micropython", "adafruit_bus_device"] +# autodoc_mock_imports = ["digitalio", "busio", "micropython", "adafruit_bus_device"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/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 672ac6b..3031961 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ +Adafruit-Blinka adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b7be913 --- /dev/null +++ b/setup.py @@ -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-max31856', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython library for the MAX31856 Universal Thermocouple Amplifier.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_MAX31856', + + # 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 max31856 universal thermocouple amplifier' + '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_max31856'], +) \ No newline at end of file From 3522b7e3d7081ca0be51470cfcd115ace05c890d Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Thu, 18 Oct 2018 14:40:43 -0400 Subject: [PATCH 2/3] Updated build badge URL --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 140600d..37c55d5 100644 --- a/README.rst +++ b/README.rst @@ -9,8 +9,8 @@ Introduction :target: https://discord.gg/nBQh6qu :alt: Discord -.. image:: https://travis-ci.org/siddacious/Adafruit_CircuitPython_MAX31856.svg?branch=master - :target: https://travis-ci.org/siddacious/Adafruit_CircuitPython_MAX31856 +.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MAX31856.svg?branch=master + :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MAX31856 :alt: Build Status A CircuitPython driver for the MAX31856 Universal Thermocouple Amplifier @@ -34,17 +34,17 @@ Usage Example import busio import digitalio import adafruit_max31856 - + # create a spi object spi = busio.SPI(board.SCK, board.MOSI, board.MISO) - + # allocate a CS pin and set the direction cs = digitalio.DigitalInOut(board.D5) cs.direction = digitalio.Direction.OUTPUT - + # create a thermocouple object with the above thermocouple = adafruit_max31856.MAX31856(spi,cs) - + # print the temperature! print(thermocouple.temperature) From d021e470fea85293f13e8350b6491e4d5a9d9720 Mon Sep 17 00:00:00 2001 From: Brennen Bearnes <74990+brennen@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:28:28 -0400 Subject: [PATCH 3/3] Add whitespace to example --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 37c55d5..3424d1c 100644 --- a/README.rst +++ b/README.rst @@ -43,7 +43,7 @@ Usage Example cs.direction = digitalio.Direction.OUTPUT # create a thermocouple object with the above - thermocouple = adafruit_max31856.MAX31856(spi,cs) + thermocouple = adafruit_max31856.MAX31856(spi, cs) # print the temperature! print(thermocouple.temperature)