From 6b2c9515bfe1cf2af15792cdbdc652d9a12a4bd4 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Tue, 7 Aug 2018 12:02:10 -0400 Subject: [PATCH] PyPi setup. --- .gitignore | 8 ++++++- .travis.yml | 39 ++++++++++++++++--------------- docs/conf.py | 2 +- requirements.txt | 2 +- setup.py | 60 ++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 89 insertions(+), 22 deletions(-) create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index e59866c..55f127b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,12 @@ +*.mpy +.idea +__pycache__ _build *.pyc -*.mpy .env build* bundles +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index b04d1db..9abe325 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,31 +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: bundles/* + file: "$TRAVIS_BUILD_DIR/bundles/*" skip_cleanup: true + overwrite: true on: tags: true - +- provider: pypi + user: adafruit-travis + on: + tags: true + password: + secure: AUoVuxg57UAMz9ZcTB7m9APh56qhBy9tcLLRJiMi7Ik/NDVnHv5RXv44opyEIEOR/PSPRZmdg+rsOfefs2inFYuo69ju1euaN4FY8j1bER7X0lIzAPzF3b3lvECQ7atPpQVQmjZRz1dMjmwQKNEPdvVSuz66FfpenX50jRVA2NI/Ve4fsysiVksfXPFmS97IJOwoGSQloSPlpwI8M6/WixCSJyCObpiTWiXysn1qTS1QVHzDX0z2pSRUzU30/YxoGvmlYUO1dDDjkcVL9AfZya0MxsozDyW5BEPHLVtly3No9SOYr7L1+G/FIsJIclcishF5lOaRG6cYbILPR/qTPabGSJnn6vUrjpjrQlzBsGjYMBoM8qDJZDo585rdfjHR8TLmS/lBW+7BEIsChezpbLpSwPfyuOuFvDWVUSZ97bsKH+ZVcMAvNEoWmBZQuylWYAficwcUYdu+7Ktq1AAfRVWPutkZ6OKZyI4/JFJ/yrFCIpBr5E7aM6ITfTlaBOU5DUyVxEX9KosLRqx7t0KkUocAOaPpmJlaCa9uao1ufPATy/fqydWjl84MGgKN3i5fiXjN9J+gdrmZtOOr9/aqjOuO6pFwuRiFxMo3RAqAv+GSTot1nWPCm4wYYV0+n45bgIw6YUkiHekW08q+Ne+nGAlg1swATi0ahHSN2tooN7o= 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_pcf8523.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pcf8523 --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_pcf8523.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pcf8523 --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/docs/conf.py b/docs/conf.py index 0a9bac3..759d794 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,7 +38,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 = ["adafruit_bus_device", "adafruit_register"] +# autodoc_mock_imports = ["adafruit_bus_device", "adafruit_register"] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/requirements.txt b/requirements.txt index 1e788f1..b6a7c61 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ adafruit-circuitpython-register -adafruit-circuitpython-bus-device>=0.2.0 +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..139b554 --- /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-pcf8523', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython library for PCF8523 real time clock.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_PCF8523', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=['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 pcf8523 real time clock rtc breakout 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_pcf8523'], +)