From 24818bb6a49395c0d7d4729e51795b12e8acb925 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Thu, 9 Aug 2018 11:56:35 -0400 Subject: [PATCH 1/2] PyPi setup. --- .gitignore | 6 +++++ .pylintrc | 2 +- .travis.yml | 38 +++++++++++++++--------------- docs/conf.py | 2 +- requirements.txt | 3 ++- setup.py | 60 ++++++++++++++++++++++++++++++++++++++++++++++++ 6 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/.pylintrc b/.pylintrc index 81d8170..039eaec 100644 --- a/.pylintrc +++ b/.pylintrc @@ -156,7 +156,7 @@ ignored-classes=optparse.Values,thread._local,_thread._local # (useful for modules/projects where namespaces are manipulated during runtime # and thus existing member attributes cannot be deduced by static analysis. It # supports qualified module names, as well as Unix pattern matching. -ignored-modules= +ignored-modules=board # Show a hint with possible names when a member name was not found. The aspect # of finding the hint is based on edit distance. diff --git a/.travis.yml b/.travis.yml index fa35077..ba3f21a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,32 +1,32 @@ -# 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: KuJmutj4+r9TKhJK3+O+3JuAQPdzZB18W5eEon5yYAsFZBSFFWzrr9ryVxTbxoNHJhw2RzKX7lYaK7fyxpxL2ubj/FU7mpvUtNbaP1eldofQRo79mCia6JGd1//upShdDY9bi86SOxX7OOab4myzXkEJC9xllbPlLfapg6i7qqM5u7x1qiP1t33VR+m0qBsdN/gD9n3whIP2mkREkigqrd5K/9j8qcAjqiV5yLNVxgNKK9wZkoxa7s1dflSyjZ1xWIKOvBpEz0PZv0IahnlJlkdkVCaR2tG7FFaJO8WKBZku1q2t0J8qtI6EXJgWCOQHyCMwrKpvPhK59aeOZsJUHNzGaAOqrp5AN0WXxtZm/VCuP0j9q7y2p5bG4e8l/z7DvQwpjCzKGIn1LBOlnLh3rDVQD/aJ2JECaPgEqhf2SzJEzUfqr2g/+YRVwKpziLqQ7PQwgBP1hXCO/NrWWBj8NY9BsK7wre5wWzxLvz4mnKH6DCrrk1LpdpBSahX9RdhtKYIcb3pm/yNUqUxG44TJ5eKEBMcCgl/+Jf0/Xu8C0Yk0j8YHn8MDl2WC7Rz41pz6EKoaeePPC7d2Criuv9HfJ+Cfe5FTY+Bl/cFXv5pCwIjtic/86XCsTaUYEzdU+zYTUGSQog9WVZtYvYOnzhpxUlPnzfCiq4nXl/NmMbNeGtw= 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 +- pip install --force-reinstall pylint==1.9.2 script: - - pylint adafruit_rtttl.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rtttl --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_rtttl.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rtttl --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/docs/conf.py b/docs/conf.py index ff33645..f5707cc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ 'sphinx.ext.viewcode', ] -autodoc_mock_imports = ["audioio", "adafruit_waveform", "pulseio"] +autodoc_mock_imports = ["pulseio"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} diff --git a/requirements.txt b/requirements.txt index 8b13789..5d5ce79 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ - +Adafruit-Blinka +adafruit-circuitpython-waveform diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..6025f6b --- /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-rtttl', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython library for playing RTTTL melodies.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_DRV2605', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-waveform'], + + # 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 rtttl tones melodies 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_rtttl'], +) From f8288efb938ffed9abb2447af188cf88cc2439ce Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Thu, 9 Aug 2018 11:59:01 -0400 Subject: [PATCH 2/2] linting. --- examples/rtttl_simpletest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/rtttl_simpletest.py b/examples/rtttl_simpletest.py index 426f800..8a4553f 100644 --- a/examples/rtttl_simpletest.py +++ b/examples/rtttl_simpletest.py @@ -22,9 +22,9 @@ # This is tested on the CircuitPlayground Express -import adafruit_rtttl import digitalio import board +import adafruit_rtttl enable = digitalio.DigitalInOut(board.SPEAKER_ENABLE) enable.switch_to_output(value=True)