From c598d241f9572ada9ab1fe9902138539bffa8cfc Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 28 Dec 2018 17:11:26 -0500 Subject: [PATCH] PyPI setup. --- .gitignore | 6 ++++++ .travis.yml | 41 +++++++++++++++++------------------ README.rst | 25 +++++++++++++++++++++ setup.py | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 113 insertions(+), 21 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 5d01f00..3518a6a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,33 +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: xenial 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: EWdhBv1VacIdKNQ0x6iMbDsOqoisqxUjosZ5KUFyQaXDh7sNWB8d/hlgEXw4YLK1kl0gsFCQN0ShkFWfJpq8LMvPVNLb9NzK8PsA+02Cqf69beBInU9qxQoKCkEfEnSS9NN4vkuPPZ9mn6iCXwDQfKUw2ek14Vvcv8NywKEAzyJv5yr1t7YyIUiDgfGkISOnNHoji0UVrtmq32tDZmKJPSIOpX6BP6Cy8+nAayCl8xWlu2LBzFvIfPFTrLF+/hYn2plBI9dV7MZKcoGWMPljCw0GUSKomKQ1++w2NIPIyJg9PlU9nzj5pdbBMFKRVSE8lmuR38cAtMuu1fIMktDP5mXpAntTnTZ5e898pOCD9793vnuS7sm0V2kEg5jQkx/1okyxK+KxA9BMpfZUD1GOvpuVtzG5iOzZxQGCaawqRYSAVbq4AGE4UYW0ri9EQe2oJ4bXw3B4AElSCehCsd9ctgxsiHcJySZ+z9363m67Dss/NwgWPo6r4PvELG13mYXxuz4gF9n8yZxcwZpQ9mPfXUpsQwWRYaLMvIFywwptJHIM0pzM+vy7HFh93S0rdmJUWwMFTxDDisyLAS+jTok4Sb3pXOO9/5ddNuf8DeWnw++s0hKCNiBTe4IqQbM/lEqCIjDPZB29+GR6gr6LHuIHoE9G8hSccEfIUuLs88tdCos= 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_pcd8544.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pcd8544 --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html && cd .. +- pylint adafruit_pcd8544.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace + examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pcd8544 --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/README.rst b/README.rst index 7fc5141..29d3b1f 100644 --- a/README.rst +++ b/README.rst @@ -26,6 +26,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. +Installing from PyPI +-------------------- + +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-pcd8544 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-pcd8544 + +To install in a virtual environment in your current project: + +.. code-block:: shell + + mkdir project-name && cd project-name + python3 -m venv .env + source .env/bin/activate + pip3 install adafruit-circuitpython-pcd8544 + Usage Example ============= diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b35c655 --- /dev/null +++ b/setup.py @@ -0,0 +1,62 @@ +"""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-pcd8544', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython display control library for Nokia PCD8544 monochrome displays.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_PCD8544', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice', + 'adafruit-circuitpython-framebuf'], + + # 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 display nokia pcd8544 monochrome displays ' + '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_pcd8544'], +) \ No newline at end of file