commit 4e0ce6188e5f6665ee46b2e83853e89898e70a35 Author: Hemna Date: Fri Sep 3 10:18:57 2021 -0400 First checkin diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..d4a2c44 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,21 @@ +# http://editorconfig.org + +root = true + +[*] +indent_style = space +indent_size = 4 +trim_trailing_whitespace = true +insert_final_newline = true +charset = utf-8 +end_of_line = lf + +[*.bat] +indent_style = tab +end_of_line = crlf + +[LICENSE] +insert_final_newline = false + +[Makefile] +indent_style = tab diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..4e72967 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ +* aprsd_weewx_plugin version: +* Python version: +* Operating System: + +### Description + +Describe what you were trying to get done. +Tell us what happened, what went wrong, and what you expected to happen. + +### What I Did + +``` +Paste the command(s) you ran and the output. +If there was a crash, please include the traceback here. +``` diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..43091aa --- /dev/null +++ b/.gitignore @@ -0,0 +1,105 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# dotenv +.env + +# virtualenv +.venv +venv/ +ENV/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ + +# IDE settings +.vscode/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..aaba487 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,15 @@ +# Config file for automatic testing at travis-ci.com + +language: python +python: + - 3.8 + - 3.7 + - 3.6 + +# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors +install: pip install -U tox-travis + +# Command to run tests, e.g. python setup.py test +script: tox + + diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..efb17e4 --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,13 @@ +======= +Credits +======= + +Development Lead +---------------- + +* Walter A. Boring IV + +Contributors +------------ + +None yet. Why not be the first? diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..0592612 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,128 @@ +.. highlight:: shell + +============ +Contributing +============ + +Contributions are welcome, and they are greatly appreciated! Every little bit +helps, and credit will always be given. + +You can contribute in many ways: + +Types of Contributions +---------------------- + +Report Bugs +~~~~~~~~~~~ + +Report bugs at https://github.com/hemna/aprsd_weewx_plugin/issues. + +If you are reporting a bug, please include: + +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. + +Fix Bugs +~~~~~~~~ + +Look through the GitHub issues for bugs. Anything tagged with "bug" and "help +wanted" is open to whoever wants to implement it. + +Implement Features +~~~~~~~~~~~~~~~~~~ + +Look through the GitHub issues for features. Anything tagged with "enhancement" +and "help wanted" is open to whoever wants to implement it. + +Write Documentation +~~~~~~~~~~~~~~~~~~~ + +aprsd_weewx_plugin could always use more documentation, whether as part of the +official aprsd_weewx_plugin docs, in docstrings, or even on the web in blog posts, +articles, and such. + +Submit Feedback +~~~~~~~~~~~~~~~ + +The best way to send feedback is to file an issue at https://github.com/hemna/aprsd_weewx_plugin/issues. + +If you are proposing a feature: + +* Explain in detail how it would work. +* Keep the scope as narrow as possible, to make it easier to implement. +* Remember that this is a volunteer-driven project, and that contributions + are welcome :) + +Get Started! +------------ + +Ready to contribute? Here's how to set up `aprsd_weewx_plugin` for local development. + +1. Fork the `aprsd_weewx_plugin` repo on GitHub. +2. Clone your fork locally:: + + $ git clone git@github.com:your_name_here/aprsd_weewx_plugin.git + +3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: + + $ mkvirtualenv aprsd_weewx_plugin + $ cd aprsd_weewx_plugin/ + $ python setup.py develop + +4. Create a branch for local development:: + + $ git checkout -b name-of-your-bugfix-or-feature + + Now you can make your changes locally. + +5. When you're done making changes, check that your changes pass flake8 and the + tests, including testing other Python versions with tox:: + + $ flake8 aprsd_weewx_plugin tests + $ python setup.py test or pytest + $ tox + + To get flake8 and tox, just pip install them into your virtualenv. + +6. Commit your changes and push your branch to GitHub:: + + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature + +7. Submit a pull request through the GitHub website. + +Pull Request Guidelines +----------------------- + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. Put + your new functionality into a function with a docstring, and add the + feature to the list in README.rst. +3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check + https://travis-ci.com/hemna/aprsd_weewx_plugin/pull_requests + and make sure that the tests pass for all supported Python versions. + +Tips +---- + +To run a subset of tests:: + +$ pytest tests.test_aprsd_weewx_plugin + + +Deploying +--------- + +A reminder for the maintainers on how to deploy. +Make sure all your changes are committed (including an entry in HISTORY.rst). +Then run:: + +$ bump2version patch # possible: major / minor / patch +$ git push +$ git push --tags + +Travis will then deploy to PyPI if tests pass. diff --git a/HISTORY.rst b/HISTORY.rst new file mode 100644 index 0000000..a2f9109 --- /dev/null +++ b/HISTORY.rst @@ -0,0 +1,8 @@ +======= +History +======= + +0.1.0 (2021-09-03) +------------------ + +* First release on PyPI. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2e28002 --- /dev/null +++ b/LICENSE @@ -0,0 +1,16 @@ +Apache Software License 2.0 + +Copyright (c) 2021, Walter A. Boring IV + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..965b2dd --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,11 @@ +include AUTHORS.rst +include CONTRIBUTING.rst +include HISTORY.rst +include LICENSE +include README.rst + +recursive-include tests * +recursive-exclude * __pycache__ +recursive-exclude * *.py[co] + +recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..1b33209 --- /dev/null +++ b/Makefile @@ -0,0 +1,87 @@ +.PHONY: clean clean-test clean-pyc clean-build docs help +.DEFAULT_GOAL := help + +define BROWSER_PYSCRIPT +import os, webbrowser, sys + +from urllib.request import pathname2url + +webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1]))) +endef +export BROWSER_PYSCRIPT + +define PRINT_HELP_PYSCRIPT +import re, sys + +for line in sys.stdin: + match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line) + if match: + target, help = match.groups() + print("%-20s %s" % (target, help)) +endef +export PRINT_HELP_PYSCRIPT + +BROWSER := python -c "$$BROWSER_PYSCRIPT" + +help: + @python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) + +clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts + +clean-build: ## remove build artifacts + rm -fr build/ + rm -fr dist/ + rm -fr .eggs/ + find . -name '*.egg-info' -exec rm -fr {} + + find . -name '*.egg' -exec rm -f {} + + +clean-pyc: ## remove Python file artifacts + find . -name '*.pyc' -exec rm -f {} + + find . -name '*.pyo' -exec rm -f {} + + find . -name '*~' -exec rm -f {} + + find . -name '__pycache__' -exec rm -fr {} + + +clean-test: ## remove test and coverage artifacts + rm -fr .tox/ + rm -f .coverage + rm -fr htmlcov/ + rm -fr .pytest_cache + +lint/flake8: ## check style with flake8 + flake8 aprsd_weewx_plugin tests + +lint: lint/flake8 ## check style + +test: ## run tests quickly with the default Python + pytest + +test-all: ## run tests on every Python version with tox + tox + +coverage: ## check code coverage quickly with the default Python + coverage run --source aprsd_weewx_plugin -m pytest + coverage report -m + coverage html + $(BROWSER) htmlcov/index.html + +docs: ## generate Sphinx HTML documentation, including API docs + rm -f docs/aprsd_weewx_plugin.rst + rm -f docs/modules.rst + sphinx-apidoc -o docs/ aprsd_weewx_plugin + $(MAKE) -C docs clean + $(MAKE) -C docs html + $(BROWSER) docs/_build/html/index.html + +servedocs: docs ## compile the docs watching for changes + watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D . + +release: dist ## package and upload a release + twine upload dist/* + +dist: clean ## builds source and wheel package + python setup.py sdist + python setup.py bdist_wheel + ls -l dist + +install: clean ## install the package to the active Python's site-packages + python setup.py install diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..17224b9 --- /dev/null +++ b/README.rst @@ -0,0 +1,41 @@ +================== +aprsd_weewx_plugin +================== + + +.. image:: https://img.shields.io/pypi/v/aprsd_weewx_plugin.svg + :target: https://pypi.python.org/pypi/aprsd_weewx_plugin + +.. image:: https://img.shields.io/travis/hemna/aprsd_weewx_plugin.svg + :target: https://travis-ci.com/hemna/aprsd_weewx_plugin + +.. image:: https://readthedocs.org/projects/aprsd-weewx-plugin/badge/?version=latest + :target: https://aprsd-weewx-plugin.readthedocs.io/en/latest/?version=latest + :alt: Documentation Status + + +.. image:: https://pyup.io/repos/github/hemna/aprsd_weewx_plugin/shield.svg + :target: https://pyup.io/repos/github/hemna/aprsd_weewx_plugin/ + :alt: Updates + + + +Ham Radio APRSD Weewx plugin for reporting weather from a weewx station + + +* Free software: Apache Software License 2.0 +* Documentation: https://aprsd-weewx-plugin.readthedocs.io. + + +Features +-------- + +* TODO + +Credits +------- + +This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. + +.. _Cookiecutter: https://github.com/audreyr/cookiecutter +.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage diff --git a/aprsd_weewx_plugin/__init__.py b/aprsd_weewx_plugin/__init__.py new file mode 100644 index 0000000..8c2f7a8 --- /dev/null +++ b/aprsd_weewx_plugin/__init__.py @@ -0,0 +1,5 @@ +"""Top-level package for aprsd_weewx_plugin.""" + +__author__ = """Walter A. Boring IV""" +__email__ = "waboring@hemna.com" +__version__ = "0.1.0" diff --git a/aprsd_weewx_plugin/aprsd_weewx_plugin.py b/aprsd_weewx_plugin/aprsd_weewx_plugin.py new file mode 100644 index 0000000..7fd803f --- /dev/null +++ b/aprsd_weewx_plugin/aprsd_weewx_plugin.py @@ -0,0 +1,96 @@ +"""Main module.""" +import logging +import queue + +import paho.mqtt.client as mqtt +from aprsd import plugin, threads, trace, utils + + +LOG = logging.getLogger("APRSD") + +mqtt_queue = queue.Queue(maxsize=20) + + +class WeewxMQTTPlugin(plugin.APRSDRegexCommandPluginBase): + """Weather + + Syntax of request + + weather + + """ + + version = "1.0" + command_regex = "^[wW]" + command_name = "weather" + + enabled = False + + def setup(self): + """Ensure that the plugin has been configured.""" + try: + utils.check_config_option(self.config, ["services", "weewx", "mqtt", "host"]) + self.enabled = True + except Exception as ex: + LOG.error(f"Failed to find config weewx:mqtt:host {ex}") + LOG.info("Disabling the weewx mqtt subsription thread.") + self.enabled = False + + def create_threads(self): + if self.enabled: + return WeewxMQTTThread( + msg_queues=mqtt_queue, + config=self.config, + ) + else: + LOG.info("WeewxMQTTPlugin not enabled due to missing config.") + + @trace.trace + def process(self, packet): + LOG.info("WeewxMQTT Plugin") + packet.get("from") + packet.get("message_text", None) + # ack = packet.get("msgNo", "0") + + if self.enabled: + # see if there are any weather messages in the queue. + msg = mqtt_queue.get(timeout=1) + if not msg: + return "No Weewx data" + else: + temp = msg["outTemp"] + return temp + + else: + return "WeewxMQTT Not enabled" + + +class WeewxMQTTThread(threads.APRSDThread): + def __init__(self, msg_queues, config): + super().__init__("WeewxMQTTThread") + self.msg_queues = msg_queues + self.config = config + self.setup() + + def setup(self): + self._mqtt_host = self.config["services"]["weewx"]["mqtt"]["host"] + self._mqtt_port = self.config["services"]["weewx"]["mqtt"]["port"] + self.client = mqtt.Client(self._mqtt_host, self._mqtt_port, 60) + self.client.on_connect = self.on_connect + self.client.on_message = self.on_message + + def on_connect(self, client, userdata, flags, rc): + LOG.info(f"Connected to MQTT {self._mqtt_host}") + client.subscribe("weather/loop") + + def on_message(self, client, userdata, msg): + LOG.debug("adding msg to queue") + mqtt_queue.put(msg.payload) + + def stop(self): + self.client.disconnect() + self.thread_stop = True + + def loop(self): + self.client.loop_forever() + return True diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..e543068 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = python -msphinx +SPHINXPROJ = aprsd_weewx_plugin +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/authors.rst b/docs/authors.rst new file mode 100644 index 0000000..e122f91 --- /dev/null +++ b/docs/authors.rst @@ -0,0 +1 @@ +.. include:: ../AUTHORS.rst diff --git a/docs/conf.py b/docs/conf.py new file mode 100755 index 0000000..d0e21df --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,162 @@ +#!/usr/bin/env python +# +# aprsd_weewx_plugin documentation build configuration file, created by +# sphinx-quickstart on Fri Jun 9 13:47:02 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another +# directory, add these directories to sys.path here. If the directory is +# relative to the documentation root, use os.path.abspath to make it +# absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + +import aprsd_weewx_plugin + +# -- General configuration --------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# 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.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +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' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'aprsd_weewx_plugin' +copyright = "2021, Walter A. Boring IV" +author = "Walter A. Boring IV" + +# 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 = aprsd_weewx_plugin.__version__ +# The full version, including alpha/beta/rc tags. +release = aprsd_weewx_plugin.__version__ + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# 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'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# 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 +# documentation. +# +# html_theme_options = {} + +# 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'] + + +# -- Options for HTMLHelp output --------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'aprsd_weewx_plugindoc' + + +# -- 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', +} + +# 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, 'aprsd_weewx_plugin.tex', + 'aprsd_weewx_plugin Documentation', + 'Walter A. Boring IV', '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, 'aprsd_weewx_plugin', + 'aprsd_weewx_plugin Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'aprsd_weewx_plugin', + 'aprsd_weewx_plugin Documentation', + author, + 'aprsd_weewx_plugin', + 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..e582053 --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1 @@ +.. include:: ../CONTRIBUTING.rst diff --git a/docs/history.rst b/docs/history.rst new file mode 100644 index 0000000..2506499 --- /dev/null +++ b/docs/history.rst @@ -0,0 +1 @@ +.. include:: ../HISTORY.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..816d924 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +Welcome to aprsd_weewx_plugin's documentation! +====================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + readme + installation + usage + modules + contributing + authors + history + +Indices and tables +================== +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..9b93adc --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,51 @@ +.. highlight:: shell + +============ +Installation +============ + + +Stable release +-------------- + +To install aprsd_weewx_plugin, run this command in your terminal: + +.. code-block:: console + + $ pip install aprsd_weewx_plugin + +This is the preferred method to install aprsd_weewx_plugin, as it will always install the most recent stable release. + +If you don't have `pip`_ installed, this `Python installation guide`_ can guide +you through the process. + +.. _pip: https://pip.pypa.io +.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ + + +From sources +------------ + +The sources for aprsd_weewx_plugin can be downloaded from the `Github repo`_. + +You can either clone the public repository: + +.. code-block:: console + + $ git clone git://github.com/hemna/aprsd_weewx_plugin + +Or download the `tarball`_: + +.. code-block:: console + + $ curl -OJL https://github.com/hemna/aprsd_weewx_plugin/tarball/master + +Once you have a copy of the source, you can install it with: + +.. code-block:: console + + $ python setup.py install + + +.. _Github repo: https://github.com/hemna/aprsd_weewx_plugin +.. _tarball: https://github.com/hemna/aprsd_weewx_plugin/tarball/master diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..f7b9069 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=python -msphinx +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=aprsd_weewx_plugin + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The Sphinx module was not found. Make sure you have Sphinx installed, + echo.then set the SPHINXBUILD environment variable to point to the full + echo.path of the 'sphinx-build' executable. Alternatively you may add the + echo.Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/readme.rst b/docs/readme.rst new file mode 100644 index 0000000..72a3355 --- /dev/null +++ b/docs/readme.rst @@ -0,0 +1 @@ +.. include:: ../README.rst diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..bf6e66d --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,7 @@ +===== +Usage +===== + +To use aprsd_weewx_plugin in a project:: + + import aprsd_weewx_plugin diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..09cfee0 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,11 @@ +pip==19.2.3 +bump2version==0.5.11 +wheel==0.33.6 +watchdog==0.9.0 +flake8==3.7.8 +tox==3.14.0 +coverage==4.5.4 +Sphinx==1.8.5 +twine==1.14.0 +pytest==6.2.4 +gray diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e520628 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +pbr +aprsd>=2.1.0 +requests +paho-mqtt diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..6f44305 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,20 @@ +[bumpversion] +current_version = 0.1.0 +commit = True +tag = True + +[bumpversion:file:setup.py] +search = version='{current_version}' +replace = version='{new_version}' + +[bumpversion:file:aprsd_weewx_plugin/__init__.py] +search = __version__ = '{current_version}' +replace = __version__ = '{new_version}' + +[bdist_wheel] +universal = 1 + +[flake8] +exclude = docs +[tool:pytest] +collect_ignore = ['setup.py'] diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..0978440 --- /dev/null +++ b/setup.py @@ -0,0 +1,44 @@ +#!/usr/bin/env python + +"""The setup script.""" + +from setuptools import setup, find_packages + +with open('README.rst') as readme_file: + readme = readme_file.read() + +with open('HISTORY.rst') as history_file: + history = history_file.read() + +requirements = [ ] + +test_requirements = ['pytest>=3', ] + +setup( + author="Walter A. Boring IV", + author_email='waboring@hemna.com', + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 2 - Pre-Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: Apache Software License', + 'Natural Language :: English', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + ], + description="Ham Radio APRSD Weewx plugin for reporting weather from a weewx station", + install_requires=requirements, + license="Apache Software License 2.0", + long_description=readme + '\n\n' + history, + include_package_data=True, + keywords='aprsd_weewx_plugin', + name='aprsd_weewx_plugin', + packages=find_packages(include=['aprsd_weewx_plugin', 'aprsd_weewx_plugin.*']), + test_suite='tests', + tests_require=test_requirements, + url='https://github.com/hemna/aprsd_weewx_plugin', + version='0.1.0', + zip_safe=False, +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e0628db --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +"""Unit test package for aprsd_weewx_plugin.""" diff --git a/tests/test_aprsd_weewx_plugin.py b/tests/test_aprsd_weewx_plugin.py new file mode 100644 index 0000000..1dac7e5 --- /dev/null +++ b/tests/test_aprsd_weewx_plugin.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python + +"""Tests for `aprsd_weewx_plugin` package.""" + +import pytest + + +@pytest.fixture +def response(): + """Sample pytest fixture. + + See more at: http://doc.pytest.org/en/latest/fixture.html + """ + # import requests + # return requests.get('https://github.com/audreyr/cookiecutter-pypackage') + + +def test_content(response): + """Sample pytest test function with the pytest fixture as an argument.""" + # from bs4 import BeautifulSoup + # assert 'GitHub' in BeautifulSoup(response.content).title.string diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..e80fa79 --- /dev/null +++ b/tox.ini @@ -0,0 +1,83 @@ +[tox] +# These are the default environments that will be run +# when ``tox`` is run without arguments. +envlist = + fmt + lint + py{37,38,39} +skip_missing_interpreters = true + + +[flake8] +# Use the more relaxed max line length permitted in PEP8. +max-line-length = 99 +# This ignore is required by black. +extend-ignore = E203 +extend-exclude = + venv + +# This is the configuration for the tox-gh-actions plugin for GitHub Actions +# https://github.com/ymyzk/tox-gh-actions +# This section is not needed if not using GitHub Actions for CI. +[gh-actions] +python = + 3.7: py37 + 3.8: py38, fmt, lint + 3.9: py39 + + +# Activate isolated build environment. tox will use a virtual environment +# to build a source distribution from the source tree. For build tools and +# arguments use the pyproject.toml file as specified in PEP-517 and PEP-518. +isolated_build = true + +[testenv] +deps = + -r{toxinidir}/requirements.txt + -r{toxinidir}/requirements-dev.txt +commands = + # Use -bb to enable BytesWarnings as error to catch str/bytes misuse. + # Use -Werror to treat warnings as errors. + {envpython} -bb -Werror -m pytest {posargs} + +[testenv:type-check] +skip_install = true +deps = + -r{toxinidir}/requirements.txt + -r{toxinidir}/requirements-dev.txt +commands = + mypy src tests + +[testenv:lint] +skip_install = true +deps = + -r{toxinidir}/requirements-dev.txt +commands = + flake8 aprsd_weewx_plugin tests + +[testenv:docs] +skip_install = true +deps = + -r{toxinidir}/requirements.txt + -r{toxinidir}/requirements-dev.txt +changedir = {toxinidir}/docs +commands = + {envpython} clean_docs.py + sphinx-apidoc --force --output-dir apidoc {toxinidir}/aprsd_weewx_plugin + sphinx-build -a -W . _build + +[testenv:fmt] +skip_install = true +deps = + -r{toxinidir}/requirements-dev.txt +commands = + gray aprsd_weewx_plugin tests + +[testenv:licenses] +skip_install = true +recreate = true +deps = + -r{toxinidir}/requirements.txt + pip-licenses +commands = + pip-licenses {posargs}