diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..97fe64d 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 pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_gc_iot_core.py b/adafruit_gc_iot_core.py index aa64f09..8a13e2b 100644 --- a/adafruit_gc_iot_core.py +++ b/adafruit_gc_iot_core.py @@ -45,11 +45,14 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_GC_IOT_Core.git" + class MQTT_API_ERROR(Exception): """Exception raised on MQTT API return-code errors.""" + # pylint: disable=unnecessary-pass pass + class MQTT_API: """Client for interacting with Google's Cloud Core MQTT API. @@ -343,7 +346,6 @@ def client_id(self): self.logger.debug("Client ID: {}".format(client_id)) return client_id - def generate_jwt(self, ttl=43200, algo="RS256"): """Generates a JSON Web Token (https://jwt.io/) using network time. :param int jwt_ttl: When the JWT token expires, defaults to 43200 minutes (or 12 hours). diff --git a/docs/conf.py b/docs/conf.py index 883990c..8271ab8 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,10 +11,10 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", ] # Uncomment the below if you use native CircuitPython modules such as @@ -21,29 +22,32 @@ # autodoc module docs will fail to generate with a warning. autodoc_mock_imports = ["adafruit_logging", "adafruit_jwt", "adafruit_ntp", "rtc"] -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 GC_IOT_CORE Library' -copyright = u'2019 Brent Rubell' -author = u'Brent Rubell' +project = "Adafruit GC_IOT_CORE Library" +copyright = "2019 Brent Rubell" +author = "Brent Rubell" # 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 = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -55,7 +59,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. @@ -67,7 +71,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 @@ -82,59 +86,62 @@ # 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 = 'AdafruitGc_iot_coreLibrarydoc' +htmlhelp_basename = "AdafruitGc_iot_coreLibrarydoc" # -- 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, 'AdafruitGC_IOT_CORELibrary.tex', u'AdafruitGC_IOT_CORE Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitGC_IOT_CORELibrary.tex", + "AdafruitGC_IOT_CORE Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -142,8 +149,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitGC_IOT_CORElibrary', u'Adafruit GC_IOT_CORE Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitGC_IOT_CORElibrary", + "Adafruit GC_IOT_CORE Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -152,7 +164,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitGC_IOT_CORELibrary', u'Adafruit GC_IOT_CORE Library Documentation', - author, 'AdafruitGC_IOT_CORELibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitGC_IOT_CORELibrary", + "Adafruit GC_IOT_CORE Library Documentation", + author, + "AdafruitGC_IOT_CORELibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/gc_iot_core_simpletest.py b/examples/gc_iot_core_simpletest.py index f7add36..932f198 100644 --- a/examples/gc_iot_core_simpletest.py +++ b/examples/gc_iot_core_simpletest.py @@ -31,7 +31,9 @@ spi = busio.SPI(board.SCK, board.MOSI, board.MISO) esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) """Use below for Most Boards""" -status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +status_light = neopixel.NeoPixel( + board.NEOPIXEL, 1, brightness=0.2 +) # Uncomment for Most Boards """Uncomment below for ItsyBitsy M4""" # status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2) # Uncomment below for an externally defined RGB LED @@ -50,35 +52,41 @@ def connect(client, userdata, flags, rc): # This function will be called when the client is connected # successfully to the broker. - print('Connected to MQTT Broker!') - print('Flags: {0}\n RC: {1}'.format(flags, rc)) + print("Connected to MQTT Broker!") + print("Flags: {0}\n RC: {1}".format(flags, rc)) # Subscribes to commands/# topic google_mqtt.subscribe_to_all_commands() # Publish to the default "events" topic - google_mqtt.publish('testing','events', qos=1) + google_mqtt.publish("testing", "events", qos=1) + def disconnect(client, userdata, rc): # This method is called when the client disconnects # from the broker. - print('Disconnected from MQTT Broker!') + print("Disconnected from MQTT Broker!") + def subscribe(client, userdata, topic, granted_qos): # This method is called when the client subscribes to a new topic. - print('Subscribed to {0} with QOS level {1}'.format(topic, granted_qos)) + print("Subscribed to {0} with QOS level {1}".format(topic, granted_qos)) + def unsubscribe(client, userdata, topic, pid): # This method is called when the client unsubscribes from a topic. - print('Unsubscribed from {0} with PID {1}'.format(topic, pid)) + print("Unsubscribed from {0} with PID {1}".format(topic, pid)) + def publish(client, userdata, topic, pid): # This method is called when the client publishes data to a topic. - print('Published to {0} with PID {1}'.format(topic, pid)) + print("Published to {0} with PID {1}".format(topic, pid)) + def message(client, topic, msg): # This method is called when the client receives data from a topic. print("Message from {}: {}".format(topic, msg)) + # Connect to WiFi print("Connecting to WiFi...") wifi.connect() @@ -93,12 +101,14 @@ def message(client, topic, msg): # print("Your JWT is: ", jwt) # Set up a new MiniMQTT Client -client = MQTT(socket, - broker = google_iot.broker, - username = google_iot.username, - password = secrets['jwt'], - client_id = google_iot.cid, - network_manager = wifi) +client = MQTT( + socket, + broker=google_iot.broker, + username=google_iot.username, + password=secrets["jwt"], + client_id=google_iot.cid, + network_manager=wifi, +) # Initialize Google MQTT API Client google_mqtt = MQTT_API(client) @@ -111,7 +121,7 @@ def message(client, topic, msg): google_mqtt.on_publish = publish google_mqtt.on_message = message -print('Attempting to connect to %s'%client.broker) +print("Attempting to connect to %s" % client.broker) google_mqtt.connect() # Pump the message loop forever, all events are diff --git a/setup.py b/setup.py index 44d4897..bcf72b5 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,52 +14,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-gc-iot-core', - + name="adafruit-circuitpython-gc-iot-core", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='Google Cloud IoT Core Client for CircuitPython', + setup_requires=["setuptools_scm"], + description="Google Cloud IoT Core Client for CircuitPython", 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_GC_IOT_CORE', - + url="https://github.com/adafruit/Adafruit_CircuitPython_GC_IOT_CORE", # 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 blinka circuitpython micropython gc_iot_core gcs, google cloud ' - 'platform, cloud, iot, core', - + keywords="adafruit blinka circuitpython micropython gc_iot_core gcs, google cloud " + "platform, cloud, iot, core", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=['adafruit_gc_iot_core'], + py_modules=["adafruit_gc_iot_core"], )