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 98aeacb..71bb5fb 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: njO2ScrtcAnC7m2HgrrYE5hmdZLHFtUhnDgArO4vuPst7JB/zj7OsfmNH8477uCBrl77IvjcBVz0xOfSGjQnLNveC1bfUz9qjyOhXwdqo2SHADBmtf4SPVtv7YF1eU+BFuczj1e9pJamhjwUG+kgSq3OIxGYBqKrxtc8OCtCgxLXlxannlqdXk4FEvV63i7MEf+49i3rHSCvp5eP5L5QwAKRfikzZQQS9nexcuCQ/YEIbMmm0vzKAamXt/0J9o6OEFJILFw3uaTWEu3jJpFNY1YoCkdv1A/jnRdt5bYzuLFR2COFnkZrH3zR5a0OcYqDGOF4xoBkggMV+2HeoaV14Q1S2N68z86SetSZkYIl01I6Ffmd8GNvCb5/JKLxXo7mEL+waSUeD5xWzXwiV/BcvBWDF9rzATLjU9ISuUfOhZ8oXDvoNN6bnkImy7A7we9dt/cCg0f9WhTTBDT5xACGrsq3o3hCmblSeIBQuo8SLqtv+HBQrEuW+NsaKxnWYUEvmMTWXV7VutSD9uPUDkPz6LIVQDaRh0OAtXXHGJDqG5WCxoVZrHSLwcZtufb5Kgh5JXV9J16p9BBpRzQtdl4WPYqgj92Ui2p/fWCwBAEfK18RiigaGwqZDzkpS2C+ri0rdzSVzjMoYfg8LyqF+k1QJKY5E9ZilvrvS/q0JInA9A8= 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_miniesptool.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-miniesptool --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html && cd .. +- pylint adafruit_miniesptool.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace + examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-miniesptool + --library_location . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/README.rst b/README.rst index 8424f46..32bb2f6 100644 --- a/README.rst +++ b/README.rst @@ -35,6 +35,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-miniesptool + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-miniesptool + +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-miniesptool + Usage Example ============= diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..cb41879 --- /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-miniesptool', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython ROM loader for ESP chips, works with ESP8266 or ESP32.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_miniesptool', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=['Adafruit-Blinka'], + + # 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 miniesptool esp8266 esp32 esp software micropython circuitpython', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + py_modules=['adafruit_miniesptool'], +) \ No newline at end of file