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 732f877..fc745a5 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: KftOBu18VF3VgT+mq7meE/waI4rrYmgwLQbgq9ozKkpQx+ZjkxqlLFCX9lHFmQhX1VxEPE58Si8wSC1d1F/g89gCVU7f/zioCRvgDCTlG10LtYjihaP8+ZkVEq4FhJrj8V4DOKl0fE/e5nCc6XLKsV3Gmey5jpemrcbbL0UixbCfZ+V0LUTDdftKV33EjIvwGE97jDOgtSb5gVEWrOxmzUnIJpN7yadfVAMLSnm4j6f4bqcasmGvtIrY8vYRIvNmu6Ho6VVzI0q/uOkOvgsWT+7sJs1ggJ0+UDcvPkib/Oli1bBH41oDLnptBwh7RYQ6zgO9tKSFNkm7BJFtk05oI/fnyCsDX7fj0jUqorwOLZDGLppXYB+KA4C14RdUM1Aj9fKE+eHRA88eDtbBUabGK5akz6VBHi5iYYS633wQO43jW8/n29s4UFMqONmOOcoH2n9/q/l7vD6Lt5A3CBh2AdRIUn5lddMuDIdfkytBsbC4eTyUQAjTFpkjVfUm/udC67SHPv6DXXurHRwOM3MFdnyLQMuxjU+lLktGqJh0DdsSSU46XjKjakY36QmQ8+Fld0en2+Tijc5ffko6FDFw6Gw8pUGmXDUjP/5sfGUAUjAIq9kTUrO0Hu09PXJB6gZw6xKXXhOeQagERW7Jmmaf9MBFJZZGY9KazCpYICmBaRc= 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_si5351.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-si5351 --library_location . - - cd docs && sphinx-build -E -W -b html . _build/html +- pylint adafruit_si5351.py +- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace + examples/*.py) +- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-si5351 --library_location + . +- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/adafruit_si5351.py b/adafruit_si5351.py index e7ceb1c..49a0f19 100644 --- a/adafruit_si5351.py +++ b/adafruit_si5351.py @@ -257,6 +257,8 @@ def frequency(self): base_frequency = self._pll.frequency / self._divider # And add a further division for the R divider if set. r_divider = self.r_divider + # pylint: disable=no-else-return + # Disable should be removed when refactor can be tested. if r_divider == R_DIV_1: return base_frequency elif r_divider == R_DIV_2: diff --git a/docs/conf.py b/docs/conf.py index 5cbd4e6..332ac54 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 = ["digitalio", "busio", "ustruct", "micropython", "adafruit_bus_device", "adafruit_bus_device.i2c_device"] +# autodoc_mock_imports = ["digitalio", "busio", "ustruct", "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..dbec762 --- /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-si5351', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython library for SI5351 clock generator module.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_SI5351', + + # 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 si5351 clock generator module 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_si5351'], +)