diff --git a/.gitignore b/.gitignore index 49bb719..55f127b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,12 @@ +*.mpy +.idea __pycache__ _build *.pyc .env build* bundles -*.mpy -.DS_Store +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index 9c3c8a2..9e7ec1a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,32 +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: fOJxBhvApJryZ+jmzSnUCcBXturFfCFjnvC6srKh0jd+EPH+3kjbDVNFz2LlziTNyQFMwHMLllF/UI3F1U4RMZjn/ppR7PegcBDAMmOjPNE0RmkjW7+1Nx3RVYp3lGt+5G2y9VdN2vgizLw5iTmrwN7+7mAOdqxFptTQGS6wLOqBoHA6T5pDx7M+FbwUlbDKd6mxhPGw7vNUwDJDEwi5Nng2WQ9mxRIpqctP967QaLnWAZcENZsSgfDtXrX70no9RFDwCn5AJXJ1sA3NKjYFMCnc4MJfY0P1BKuO9+3weUB+SpvZHr7OOFYMdNwNKm0yBKXG2GpG5VkQtiU5oIt3hlC6fql/JlH90r3zgyRZ/CF3JN2ajKEioWuVNSESWbxkOYLVpz9CkB0OHLq6KgMWiU5/9nFz/w6Ij6w8zl5MQlbGbW+VU7obxmviCyf81QgJmiWZ9ZqaBFuqoJSaOmGq09dPIcVKznw4KFdvWEnglL6DHT13O6CkFjUXu1/3sI9Rjdz0Uc3r0Jf+mKoGVwimTih84IN7Fh8iCVPqXNhdXJkRqdtmb0TKFPmIiTlvW7R69d0x9aTMU05ZTitMjam0YhpygjAIOmL66Vs/cWbQuDVWCBiNGHctu0uz9cVuFQYdhb5BcAY4y2t1Ib8vu02tAY25Acru6uxA0ChcRaLrkB8= 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_rfm9x.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rfm9x --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_rfm9x.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace + examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rfm9x --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/adafruit_rfm9x.py b/adafruit_rfm9x.py index 72d533d..62eb246 100644 --- a/adafruit_rfm9x.py +++ b/adafruit_rfm9x.py @@ -382,6 +382,8 @@ def __init__(self, spi, cs, reset, frequency, *, preamble_length=8, # Set TX power to low defaut, 13 dB. self.tx_power = 13 + # pylint: disable=no-member + # Reconsider pylint: disable when this can be tested def _read_into(self, address, buf, length=None): # Read a number of bytes from the specified address into the provided # buffer. If length is not specified (the default) the entire buffer diff --git a/docs/conf.py b/docs/conf.py index 30dfce6..5edbd67 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", "adafruit_bus_device.spi_device", "adafruit_bus_device"] +# autodoc_mock_imports = ["digitalio", "busio", "micropython", "adafruit_bus_device.spi_device", "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/examples/rfm9x_simpletest.py b/examples/rfm9x_simpletest.py index 5490036..a9b4220 100644 --- a/examples/rfm9x_simpletest.py +++ b/examples/rfm9x_simpletest.py @@ -8,16 +8,16 @@ # Define radio parameters. -RADIO_FREQ_MHZ = 915.0 # Frequency of the radio in Mhz. Must match your - # module! Can be a value like 915.0, 433.0, etc. +RADIO_FREQ_MHZ = 915.0 # Frequency of the radio in Mhz. Must match your + # module! Can be a value like 915.0, 433.0, etc. # Define pins connected to the chip, use these if wiring up the breakout according to the guide: -CS = digitalio.DigitalInOut(board.D5) +CS = digitalio.DigitalInOut(board.D5) RESET = digitalio.DigitalInOut(board.D6) # Or uncomment and instead use these if using a Feather M0 RFM9x board and the appropriate # CircuitPython build: -#CS = digitalio.DigitalInOut(board.RFM9X_CS) -#RESET = digitalio.DigitalInOut(board.RFM9X_RST) +# CS = digitalio.DigitalInOut(board.RFM9X_CS) +# RESET = digitalio.DigitalInOut(board.RFM9X_RST) # Initialize SPI bus. spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO) 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..236f5f4 --- /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-rfm9x', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython library for RFM95/6/7/8 LoRa 433/915mhz radio modules.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_RFM9x', + + # 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 lora radio rfm95 rfm9x rfm96 rfm97 rfm98 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_rfm9x'], +)