diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..1dad804 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -40,7 +40,7 @@ jobs: source actions-ci/install.sh - name: Pip install pylint, black, & Sphinx run: | - pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme + pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_hcsr04.py b/adafruit_hcsr04.py index 9545b1d..dad9482 100644 --- a/adafruit_hcsr04.py +++ b/adafruit_hcsr04.py @@ -52,13 +52,15 @@ _USE_PULSEIO = False try: from pulseio import PulseIn + _USE_PULSEIO = True except ImportError: - pass # This is OK, we'll try to bitbang it! + pass # This is OK, we'll try to bitbang it! __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_HCSR04.git" + class HCSR04: """Control a HC-SR04 ultrasonic range sensor. @@ -82,6 +84,7 @@ class HCSR04: pass time.sleep(0.1) """ + def __init__(self, trigger_pin, echo_pin, *, timeout=0.1): """ :param trigger_pin: The pin on the microcontroller that's connected to the @@ -142,10 +145,10 @@ def distance(self): def _dist_two_wire(self): if _USE_PULSEIO: - self._echo.clear() # Discard any previous pulse values + self._echo.clear() # Discard any previous pulse values self._trig.value = True # Set trig high - time.sleep(0.00001) # 10 micro seconds 10/1000/1000 - self._trig.value = False # Set trig low + time.sleep(0.00001) # 10 micro seconds 10/1000/1000 + self._trig.value = False # Set trig low pulselen = None timestamp = time.monotonic() @@ -170,7 +173,7 @@ def _dist_two_wire(self): if time.monotonic() - timestamp > self._timeout: raise RuntimeError("Timed out") pulselen = time.monotonic() - timestamp - pulselen *= 1000000 # convert to us to match pulseio + pulselen *= 1000000 # convert to us to match pulseio if pulselen >= 65535: raise RuntimeError("Timed out") diff --git a/docs/conf.py b/docs/conf.py index d20ea8a..a346656 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -10,39 +11,41 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.viewcode', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.viewcode", ] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None), - 'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", None), + "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), +} # Show the docstring from both the class and its __init__() method -autoclass_content = 'both' -autodoc_member_order = 'bysource' +autoclass_content = "both" +autodoc_member_order = "bysource" # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit HCSR04 Library' -copyright = u'2017 Mike Mabey' -author = u'Mike Mabey' +project = u"Adafruit HCSR04 Library" +copyright = u"2017 Mike Mabey" +author = u"Mike Mabey" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The full version, including alpha/beta/rc tags. -release = open('../VERSION').read().strip() +release = open("../VERSION").read().strip() # The short X.Y version. -version = '.'.join(release.split('.')[:2]) +version = ".".join(release.split(".")[:2]) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -54,7 +57,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -66,7 +69,7 @@ add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -77,53 +80,56 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +on_rtd = os.environ.get("READTHEDOCS", None) == "True" if not on_rtd: # only import and set the theme if we're building docs locally try: import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.'] + + html_theme = "sphinx_rtd_theme" + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] except: - html_theme = 'default' - html_theme_path = ['.'] + html_theme = "default" + html_theme_path = ["."] else: - html_theme_path = ['.'] + html_theme_path = ["."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitHCSR04Librarydoc' +htmlhelp_basename = "AdafruitHCSR04Librarydoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'AdafruitHCSR04Library.tex', u'Adafruit HCSR04 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitHCSR04Library.tex", + u"Adafruit HCSR04 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -131,8 +137,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'adafruitHCSR04library', u'Adafruit HCSR04 Library Documentation', - [author], 1) + ( + master_doc, + "adafruitHCSR04library", + u"Adafruit HCSR04 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -141,7 +152,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitHCSR04Library', u'Adafruit HCSR04 Library Documentation', - author, 'AdafruitHCSR04Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitHCSR04Library", + u"Adafruit HCSR04 Library Documentation", + author, + "AdafruitHCSR04Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/setup.py b/setup.py index 8d2379f..b24954d 100644 --- a/setup.py +++ b/setup.py @@ -7,6 +7,7 @@ # Always prefer setuptools over distutils from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -14,47 +15,38 @@ 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: +with open(path.join(here, "README.rst"), encoding="utf-8") as f: long_description = f.read() setup( - name='adafruit-circuitpython-hcsr04', - + name="adafruit-circuitpython-hcsr04", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for controlling HC-SR04 ultrasonic range sensors.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for controlling HC-SR04 ultrasonic range sensors.", long_description=long_description, - long_description_content_type='text/x-rst', - + long_description_content_type="text/x-rst", # The project's main homepage. - url='https://github.com/adafruit/Adafruit_CircuitPython_HCSR04', - + url="https://github.com/adafruit/Adafruit_CircuitPython_HCSR04", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka'], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], # Choose your license - license='MIT', - + 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', + "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 hcsr04 hardware micropython circuitpython ultrasonic', - + keywords="adafruit hcsr04 hardware micropython circuitpython ultrasonic", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - py_modules=['adafruit_hcsr04'], -) \ No newline at end of file + py_modules=["adafruit_hcsr04"], +)