diff --git a/.gitignore b/.gitignore index 6262b77..55f127b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,12 @@ +*.mpy +.idea __pycache__ _build *.pyc .env build* bundles -*.mpy +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index a2f0259..59ab6c7 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: tGmGV8hzGE5KcjMCMKFEk9dCN0ra7szkUfKIp97cOFohfQ1BndKHb23K/0KglkiwWDAoYITFEYoPwHK3KDMYDhSyVcFz86tqXCu62i4XdcwL/tgDNuhesTAZOMRdRk2s9IKz5oa0rdsmKNqhTkjw/bQxUY0xZz/KPyafz93dpXOzzgVHr/01v3kjL8elPlfCm5S0+Jzx5UJ1Oj092gPhdjR9QfAlKsy10ievqP6IwpQ4lf2LV6eFRLdfDEGUdViOuUNpC8MxTNDSJex9zd/oqT5l0zmfrRY4E4CDQFbLercWeZOqD5Ru1bG6gjZfdW3H/W1sbXt5DENV8yLCIoSx5j9vgeO4d/BC06MniUjutFIbKG5H5B08CDF123V+Ml8mUxbJegG1QZYviZPekc6y7TNt1OEZedH7D2dIfyU2I9XQ7AfhW2yoXNfxjVT1pCPn/cDnmLuXsTFXZkflQLEgTvMLbOtDT5kSG7vm/FPASqeWIUWBPwISmGniIiCctVyEmelVbK/JEdjDbrtHNhmtCX4jb0qmG4n5antbg8ZZ5Th5m9PNHv+O7g9vZ1EVbcahMrP9lPO1I5pAY2g6i9jQK42CW+5NUlbaxNoF/OOGVl8iOQ+GKnQ8c6zJLlJQYn8lh94xJeiJH7roX1pT/9wo8yXBbRlLtbLsAILil634A90= 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_vcnl4010.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-vcnl4010 --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_vcnl4010.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-vcnl4010 --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/docs/conf.py b/docs/conf.py index de734fa..636255d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,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 = ["micropython", "adafruit_bus_device"] +# autodoc_mock_imports = ["micropython", "adafruit_bus_device"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} diff --git a/requirements.txt b/requirements.txt index c47d35a..3031961 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ -adafruit-circuitpython-bus-device +Adafruit-Blinka +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..cbb56a0 --- /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-vcnl4010', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython library for VCNL4010 proximity and light sensor.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_VCNL4010', + + # 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 vcnl4010 proximity light sensor 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_vcnl4010'], +)