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 386b8d5..9952cf1 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: wORz8nUO09Z+9Ii5ZhzbKQT/YDfkx2WCNZPsR0qNwfk1I1E36CsRyC1gJW5E+PAKP5D0k/xceh0FtImK3+GcDbeW8YyPbKIaSykxszAW8eRGoo4r43SYfCpVYDmF4JDuuLBchPGFy1wwKasuWomXCvrBUOh6FftsHwop6sXSOhFfnh9DG2GEFgOLBDRH3YHaf8K3w/h+9wZCkBI+b8bEQTaVUw27Qc9NUnRPTEBZ2t1I/YUqkKb/PaWY7AGeNaCJJbXdrgl7dneyvwLHklQijcRTLW35i8e2xQM4qZ2bgW7UXotUXMXPD65W/FRChuS5AR580ZM4IJdQv8SrAK7l6Gz8bjFzTWelmvSJFJPKoXFkXIgu3+MtJdDcdMUyS0Hbl/LXUcDligwtK9nMiU4Pg+6AtuVJzHQTSCcSvKezM2ORLog2MjDMXd91Ae1rmkpt3uHZBmMS5wY0I+QFKOK8/uI2vtOUfHRlmaKZblHXiQHeON/rQvngjN+omn9+OiiHAfRHGXpcR0ESIWHi4sTWRC/bn2bPs1aCrYq+nd9tKekkg0nUfMhLejjafgh96iFbvKgePPwyo8qfuEcMkSk2ZzxpgWGPCEj2le6ChqJbdd9dQQXqpKhe5yMshetUdicqU+kKKQ6b7pQUzOgjqYZpEdZDrLNJb+/imiwVaNriK8g= 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_tsl2561.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tsl2561 --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_tsl2561.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tsl2561 --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/README.rst b/README.rst index 0720d76..9012657 100644 --- a/README.rst +++ b/README.rst @@ -10,8 +10,8 @@ Introduction :target: https://adafru.it/discord :alt: Discord -.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TLS2561.svg?branch=master - :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TLS2561 +.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TSL2561.svg?branch=master + :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_TSL2561 :alt: Build Status CircuitPython driver for TSL2561 Light Sensor. @@ -93,4 +93,3 @@ Now, once you have the virtual environment activated: This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass. - diff --git a/adafruit_tsl2561.py b/adafruit_tsl2561.py index c4eafc7..f1a2a0b 100644 --- a/adafruit_tsl2561.py +++ b/adafruit_tsl2561.py @@ -194,6 +194,8 @@ def _disable(self): self._write_control_register(_CONTROL_POWEROFF) def _read_register(self, reg, count=1): + # pylint: disable=no-else-return + # Disable should be removed when refactor can be tested self.buf[0] = _COMMAND_BIT | reg if count == 2: self.buf[0] |= _WORD_BIT diff --git a/docs/conf.py b/docs/conf.py index d72b9a6..378377d 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),'Register': ('https://circuitpython.readthedocs.io/projects/register/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..e70bd92 --- /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-tsl2561', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython library for TSL2561 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_TSL2561', + + # 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 tsl2561 light sensor 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_tsl2561'], +)