Skip to content

Ran black, updated to pylint 2.x #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 12 additions & 10 deletions adafruit_ds2413.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,18 @@
__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DS2413.git"

from adafruit_onewire.device import OneWireDevice
from micropython import const
from adafruit_onewire.device import OneWireDevice

_DS2413_ACCESS_READ = b'\xF5'
_DS2413_ACCESS_WRITE = b'\x5A'
_DS2413_ACK_SUCCESS = b'\xAA'
_DS2413_ACK_ERROR = b'\xFF'
_DS2413_ACCESS_READ = b"\xF5"
_DS2413_ACCESS_WRITE = b"\x5A"
_DS2413_ACK_SUCCESS = b"\xAA"
_DS2413_ACK_ERROR = b"\xFF"
INPUT = const(0)
OUTPUT = const(1)

class DS2413Pin():

class DS2413Pin:
"""Class which provides interface to single DS2413 GPIO pin."""

def __init__(self, number, host, direction=OUTPUT):
Expand All @@ -51,7 +52,7 @@ def __init__(self, number, host, direction=OUTPUT):
self._number = number
self._host = host
self._mask = 1 << (number * 2)
self._direction = None # create it, and then...
self._direction = None # create it, and then...
self.direction = direction # set it through setter

@property
Expand Down Expand Up @@ -96,7 +97,8 @@ def value(self, state):
new |= 1 << self._number
self._host.pio_state = new

class DS2413():

class DS2413:
"""Class which provides interface to DS2413 GPIO breakout."""

def __init__(self, bus, address):
Expand All @@ -107,7 +109,7 @@ def __init__(self, bus, address):
self._IOA = None
self._IOB = None
else:
raise RuntimeError('Incorrect family code in device address.')
raise RuntimeError("Incorrect family code in device address.")

@property
def IOA(self):
Expand Down Expand Up @@ -148,4 +150,4 @@ def _write_latches(self, value):
dev.write(self._buf, end=2)
dev.readinto(self._buf, end=1)
if not self._buf[0] == ord(_DS2413_ACK_SUCCESS):
raise RuntimeError('ACK failure.')
raise RuntimeError("ACK failure.")
110 changes: 64 additions & 46 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,51 @@

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

sys.path.insert(0, os.path.abspath(".."))

# -- General configuration ------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# 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",
]

# 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 = ["adafruit_onewire", "micropython"]

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),
}

# 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 DS2413 Library'
copyright = u'2017 Carter Nelson'
author = u'Carter Nelson'
project = u"Adafruit DS2413 Library"
copyright = u"2017 Carter Nelson"
author = u"Carter Nelson"

# 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 short X.Y version.
version = u'1.0'
version = u"1.0"
# The full version, including alpha/beta/rc tags.
release = u'1.0'
release = u"1.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -54,7 +58,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', '.env', 'CODE_OF_CONDUCT.md']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand All @@ -66,7 +70,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
Expand All @@ -80,68 +84,76 @@
# 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"]

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
html_favicon = '_static/favicon.ico'
html_favicon = "_static/favicon.ico"

# Output file base name for HTML help builder.
htmlhelp_basename = 'AdafruitDs2413Librarydoc'
htmlhelp_basename = "AdafruitDs2413Librarydoc"

# -- 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, 'AdafruitDS2413Library.tex', u'AdafruitDS2413 Library Documentation',
author, 'manual'),
(
master_doc,
"AdafruitDS2413Library.tex",
u"AdafruitDS2413 Library Documentation",
author,
"manual",
),
]

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'AdafruitDS2413library', u'Adafruit DS2413 Library Documentation',
[author], 1)
(
master_doc,
"AdafruitDS2413library",
u"Adafruit DS2413 Library Documentation",
[author],
1,
)
]

# -- Options for Texinfo output -------------------------------------------
Expand All @@ -150,7 +162,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'AdafruitDS2413Library', u'Adafruit DS2413 Library Documentation',
author, 'AdafruitDS2413Library', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"AdafruitDS2413Library",
u"Adafruit DS2413 Library Documentation",
author,
"AdafruitDS2413Library",
"One line description of project.",
"Miscellaneous",
),
]
50 changes: 21 additions & 29 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,54 +7,46 @@

# 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:
with open(path.join(here, "README.rst"), encoding="utf-8") as f:
long_description = f.read()

setup(
name='adafruit-circuitpython-ds2413',

name="adafruit-circuitpython-ds2413",
use_scm_version=True,
setup_requires=['setuptools_scm'],

description='CircuitPython library for DS2413 1-Wire Dual Channel Addressable Switch.',
setup_requires=["setuptools_scm"],
description="CircuitPython library for DS2413 1-Wire Dual Channel Addressable Switch.",
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_DS2413',

url="https://github.com/adafruit/Adafruit_CircuitPython_DS2413",
# Author details
author='Adafruit Industries',
author_email='[email protected]',

install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],

author="Adafruit Industries",
author_email="[email protected]",
install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
# 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 haptic motor controller buzzer vibration breakout hardware micropython circuitpython',

keywords="adafruit haptic motor controller buzzer vibration 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_ds2413'],
py_modules=["adafruit_ds2413"],
)