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 dce0e75..247dcb3 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: fUkBtsfJreIZjKd4xt8oI6qwjfOgXf59EODfoak9vCdh9AFqZCw3p6oGI5ndfauxWy8Td7R2oF3vvO1F4WTOJy/d374MxhQqq1PksSDZm9XfwOJWMu8Rh/QVTK122Jucku1smt/arP1jG1GwcxSQefUMWk8R+Q/DFbCdMezvl3HcjcMt1uSw1676aYGr2syLYptpk1AWuN0NrOVpvDTUXS2BBPtIT8Z0VbeocRVAL71+RmuWj472t5kwWWFeCetv1BVceZkBbo4rGAEK3+5YjdMdAnb/FIecz7k4NJp/t4VTHk760pliqCfkQe0nRQjjX0ZKZJ8lHHvVWfY6nyKC32Gp39Jszwwznvu2iU6ET1QOcs12vb8INTKJQD1dyboV1yexYhQt4LFKYxYwifQSb4zfbdd5+XMGYpnauw4p2cNPeFjaPSBYBQ/xntkSctV1Shzp+eWg1BuXXefOORHylu528vsiqH6XvXJ/r/FJa9cmtkd/euftXr2cNqFt5wGPeUcuOr3N6TKSuNfuXGPmqryejTX3O8hsDnI8KRdDGPG112k8pB+Hg5WZ+Z7/abonpWLVJAUoCcFFW6GMD2ZfbJNjKjWBDtJtyJCuSr4iamBqY0+AhuXNc29KdZAKToa1zTZ1Av1zX1AFb00ZrLKMz3yS3XI7Qf15BtVOLTBRaHA= 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_fram.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fram --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_fram.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace + examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fram --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/README.rst b/README.rst index 0ef5787..765c6bb 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-fram + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-fram + +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-fram + Usage Example ============= diff --git a/docs/conf.py b/docs/conf.py index 2033a02..8339085 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,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"] +# autodoc_mock_imports = ["digitalio", "busio", "micropython"] 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/setup.py b/setup.py new file mode 100644 index 0000000..654b28d --- /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-fram', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython/Python library to support the I2C and SPI FRAM Breakouts.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_FRAM', + + # 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 spi fram 12c 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_fram'], +) \ No newline at end of file