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/.pylintrc b/.pylintrc index 8e9553a..d8f0ee8 100644 --- a/.pylintrc +++ b/.pylintrc @@ -119,7 +119,7 @@ spelling-store-unknown-words=no [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. -#notes=FIXME,XXX,TODO +# notes=FIXME,XXX,TODO notes=FIXME,XXX @@ -301,7 +301,7 @@ function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Good variable names which should always be accepted, separated by a comma # good-names=i,j,k,ex,Run,_ -good-names=r,g,b,i,j,k,n,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ # Include a hint for the correct naming format with invalid-name include-naming-hint=no @@ -423,7 +423,7 @@ max-returns=6 max-statements=50 # Minimum number of public methods for a class (see R0903). -min-public-methods=2 +min-public-methods=1 [EXCEPTIONS] diff --git a/docs/conf.py b/docs/conf.py index a777e77..219535d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,8 @@ # import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -30,9 +31,9 @@ # 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 @@ -41,34 +42,34 @@ # autodoc_mock_imports = ["adafruit_register", "adafruit_bus_device"] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. # # source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit DS1307 Library' -copyright = u'2016, Philip Moyer and Adafruit Industries' -author = u'Philip Moyer' +project = u"Adafruit DS1307 Library" +copyright = u"2016, Philip Moyer and Adafruit Industries" +author = u"Philip Moyer" # 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. @@ -89,7 +90,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. @@ -111,7 +112,7 @@ # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] @@ -131,18 +132,19 @@ # 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 = ["."] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -176,13 +178,13 @@ # 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" # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -262,34 +264,36 @@ # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitDS1307Librarydoc' +htmlhelp_basename = "AdafruitDS1307Librarydoc" # -- 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, 'AdafruitDS1307Library.tex', u'Adafruit DS1307 Library Documentation', - u'Phiilip Moyer', 'manual'), + ( + master_doc, + "AdafruitDS1307Library.tex", + u"Adafruit DS1307 Library Documentation", + u"Phiilip Moyer", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of @@ -330,8 +334,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'adafruitds1307library', u'Adafruit DS1307 Library Documentation', - [author], 1) + ( + master_doc, + "adafruitds1307library", + u"Adafruit DS1307 Library Documentation", + [author], + 1, + ) ] # If true, show URL addresses after external links. @@ -345,9 +354,15 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitDS1307Library', u'Adafruit DS1307 Library Documentation', - author, 'AdafruitDS1307Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitDS1307Library", + u"Adafruit DS1307 Library Documentation", + author, + "AdafruitDS1307Library", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. @@ -366,5 +381,7 @@ # # texinfo_no_detailmenu = False -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), +} diff --git a/examples/ds1307_simpletest.py b/examples/ds1307_simpletest.py index 82bfd30..f8509ec 100644 --- a/examples/ds1307_simpletest.py +++ b/examples/ds1307_simpletest.py @@ -5,10 +5,12 @@ import time import board + # For hardware I2C (M0 boards) use this line: import busio as io + # Or for software I2C (ESP8266) use this line instead: -#import bitbangio as io +# import bitbangio as io import adafruit_ds1307 @@ -22,23 +24,27 @@ days = ("Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday") -#pylint: disable-msg=bad-whitespace -#pylint: disable-msg=using-constant-test -if False: # change to True if you want to set the time! +# pylint: disable-msg=bad-whitespace +# pylint: disable-msg=using-constant-test +if False: # change to True if you want to set the time! # year, mon, date, hour, min, sec, wday, yday, isdst - t = time.struct_time((2017, 10, 29, 15, 14, 15, 0, -1, -1)) + t = time.struct_time((2017, 10, 29, 15, 14, 15, 0, -1, -1)) # you must set year, mon, date, hour, min, sec and weekday # yearday is not supported, isdst can be set but we don't do anything with it at this time - print("Setting time to:", t) # uncomment for debugging + print("Setting time to:", t) # uncomment for debugging rtc.datetime = t print() -#pylint: enable-msg=using-constant-test -#pylint: enable-msg=bad-whitespace +# pylint: enable-msg=using-constant-test +# pylint: enable-msg=bad-whitespace # Main loop: while True: t = rtc.datetime - #print(t) # uncomment for debugging - print("The date is {} {}/{}/{}".format(days[int(t.tm_wday)], t.tm_mday, t.tm_mon, t.tm_year)) + # print(t) # uncomment for debugging + print( + "The date is {} {}/{}/{}".format( + days[int(t.tm_wday)], t.tm_mday, t.tm_mon, t.tm_year + ) + ) print("The time is {}:{:02}:{:02}".format(t.tm_hour, t.tm_min, t.tm_sec)) - time.sleep(1) # wait a second + time.sleep(1) # wait a second diff --git a/setup.py b/setup.py index aa711be..7390a0d 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,41 @@ 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-ds1307', - + name="adafruit-circuitpython-ds1307", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for DS1307 real time clock.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for DS1307 real time clock.", 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_DS1307', - + url="https://github.com/adafruit/Adafruit_CircuitPython_DS1307", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['adafruit-circuitpython-register', 'adafruit-circuitpython-busdevice'], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=[ + "adafruit-circuitpython-register", + "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 real time clock rtc breakout hardware micropython circuitpython', - + keywords="adafruit real time clock rtc 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_ds1307'], + py_modules=["adafruit_ds1307"], )