Compare commits
No commits in common. "v0.1.1" and "master" have entirely different histories.
|
@ -1,21 +0,0 @@
|
|||
# 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
|
|
@ -0,0 +1,12 @@
|
|||
# These are supported funding model platforms
|
||||
|
||||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
patreon: wb4bor
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
|
@ -1,15 +0,0 @@
|
|||
* 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.
|
||||
```
|
|
@ -1,105 +0,0 @@
|
|||
# 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/
|
|
@ -0,0 +1,23 @@
|
|||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v3.4.0
|
||||
hooks:
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
- id: check-yaml
|
||||
- id: check-added-large-files
|
||||
- id: detect-private-key
|
||||
- id: check-merge-conflict
|
||||
- id: check-case-conflict
|
||||
- id: check-docstring-first
|
||||
- id: check-builtin-literals
|
||||
|
||||
- repo: https://github.com/asottile/setup-cfg-fmt
|
||||
rev: v1.16.0
|
||||
hooks:
|
||||
- id: setup-cfg-fmt
|
||||
|
||||
- repo: https://github.com/dizballanze/gray
|
||||
rev: v0.10.1
|
||||
hooks:
|
||||
- id: gray
|
15
.travis.yml
15
.travis.yml
|
@ -1,15 +0,0 @@
|
|||
# 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
|
||||
|
||||
|
1
AUTHORS
1
AUTHORS
|
@ -1 +1,2 @@
|
|||
Hemna <waboring@hemna.com>
|
||||
Walter A. Boring IV <waboring@hemna.com>
|
||||
|
|
13
AUTHORS.rst
13
AUTHORS.rst
|
@ -1,13 +0,0 @@
|
|||
=======
|
||||
Credits
|
||||
=======
|
||||
|
||||
Development Lead
|
||||
----------------
|
||||
|
||||
* Walter A. Boring IV <waboring@hemna.com>
|
||||
|
||||
Contributors
|
||||
------------
|
||||
|
||||
None yet. Why not be the first?
|
128
CONTRIBUTING.rst
128
CONTRIBUTING.rst
|
@ -1,128 +0,0 @@
|
|||
.. 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.
|
39
ChangeLog
39
ChangeLog
|
@ -1,10 +1,39 @@
|
|||
CHANGES
|
||||
=======
|
||||
|
||||
v0.1.0
|
||||
v0.3.2
|
||||
------
|
||||
|
||||
* updated setup.cfg
|
||||
* first hack at it working
|
||||
* Switched to pbr
|
||||
* First checkin
|
||||
* another try
|
||||
|
||||
v0.3.1
|
||||
------
|
||||
|
||||
* Updated pressure \* 10
|
||||
|
||||
v0.3.0
|
||||
------
|
||||
|
||||
* Take the pressure from pressure\_inHg
|
||||
|
||||
v0.2.0
|
||||
------
|
||||
|
||||
* update for 0.2.0
|
||||
* Fixed pep8 failures
|
||||
* Update to aprsd 3.0.0 and include config options!
|
||||
* don't dump the whole packet
|
||||
* use Tx to send
|
||||
* Working with pre 2.7.0
|
||||
* Removed trace
|
||||
* lint
|
||||
* Added pbr version
|
||||
* Fixed missing entry in requirements.txt
|
||||
* Create FUNDING.yml
|
||||
|
||||
v0.1.2
|
||||
------
|
||||
|
||||
* Fixed README.rst formatting
|
||||
* Updated from first repo
|
||||
* Initial commit
|
||||
|
|
|
@ -1,8 +0,0 @@
|
|||
=======
|
||||
History
|
||||
=======
|
||||
|
||||
0.1.0 (2021-09-03)
|
||||
------------------
|
||||
|
||||
* First release on PyPI.
|
681
LICENSE
681
LICENSE
|
@ -1,16 +1,675 @@
|
|||
Apache Software License 2.0
|
||||
|
||||
Copyright (c) 2021, Walter A. Boring IV
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
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
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
Preamble
|
||||
|
||||
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.
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
|
11
MANIFEST.in
11
MANIFEST.in
|
@ -1,11 +0,0 @@
|
|||
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
|
32
Makefile
32
Makefile
|
@ -21,8 +21,36 @@ docs: build
|
|||
cp Changelog docs/changelog.rst
|
||||
tox -edocs
|
||||
|
||||
clean: clean-venv ## Clean out any build artifacts to start over
|
||||
rm -rf dist/*
|
||||
clean: clean-build clean-pyc clean-test clean-dev ## 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
|
||||
|
||||
clean-dev: ## Clean out the venv
|
||||
rm -rf $(VENVDIR)
|
||||
rm Makefile.venv
|
||||
|
||||
coverage: ## check code coverage quickly with the default Python
|
||||
coverage run --source aprsd_weewx_plugin setup.py test
|
||||
coverage report -m
|
||||
coverage html
|
||||
$(BROWSER) htmlcov/index.html
|
||||
|
||||
test: dev ## Run all the tox tests
|
||||
tox -p all
|
||||
|
|
108
README.rst
108
README.rst
|
@ -1,30 +1,36 @@
|
|||
==================
|
||||
aprsd_weewx_plugin
|
||||
==================
|
||||
APRSD Weewx Plugin
|
||||
===================
|
||||
|
||||
|PyPI| |Status| |Python Version| |License|
|
||||
|
||||
.. image:: https://img.shields.io/pypi/v/aprsd_weewx_plugin.svg
|
||||
:target: https://pypi.python.org/pypi/aprsd_weewx_plugin
|
||||
|Read the Docs| |Tests| |Codecov|
|
||||
|
||||
.. image:: https://img.shields.io/travis/hemna/aprsd_weewx_plugin.svg
|
||||
:target: https://travis-ci.com/hemna/aprsd_weewx_plugin
|
||||
|pre-commit|
|
||||
|
||||
.. 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.
|
||||
.. |PyPI| image:: https://img.shields.io/pypi/v/aprsd-weewx-plugin.svg
|
||||
:target: https://pypi.org/project/aprsd-weewx-plugin/
|
||||
:alt: PyPI
|
||||
.. |Status| image:: https://img.shields.io/pypi/status/aprsd-weewx-plugin.svg
|
||||
:target: https://pypi.org/project/aprsd-weewx-plugin/
|
||||
:alt: Status
|
||||
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/aprsd-weewx-plugin
|
||||
:target: https://pypi.org/project/aprsd-weewx-plugin
|
||||
:alt: Python Version
|
||||
.. |License| image:: https://img.shields.io/pypi/l/aprsd-weewx-plugin
|
||||
:target: https://opensource.org/licenses/GNU GPL v3.0
|
||||
:alt: License
|
||||
.. |Read the Docs| image:: https://img.shields.io/readthedocs/aprsd-weewx-plugin/latest.svg?label=Read%20the%20Docs
|
||||
:target: https://aprsd-weewx-plugin.readthedocs.io/
|
||||
:alt: Read the documentation at https://aprsd-weewx-plugin.readthedocs.io/
|
||||
.. |Tests| image:: https://github.com/hemna/aprsd-weewx-plugin/workflows/Tests/badge.svg
|
||||
:target: https://github.com/hemna/aprsd-weewx-plugin/actions?workflow=Tests
|
||||
:alt: Tests
|
||||
.. |Codecov| image:: https://codecov.io/gh/hemna/aprsd-weewx-plugin/branch/main/graph/badge.svg
|
||||
:target: https://codecov.io/gh/hemna/aprsd-weewx-plugin
|
||||
:alt: Codecov
|
||||
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
|
||||
:target: https://github.com/pre-commit/pre-commit
|
||||
:alt: pre-commit
|
||||
|
||||
|
||||
Features
|
||||
|
@ -32,10 +38,62 @@ Features
|
|||
|
||||
* TODO
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
* TODO
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
You can install *APRSD Weewx Plugin* via pip_ from PyPI_:
|
||||
|
||||
.. code:: console
|
||||
|
||||
$ pip install aprsd-weewx-plugin
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Please see the `Command-line Reference <Usage_>`_ for details.
|
||||
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
Contributions are very welcome.
|
||||
To learn more, see the `Contributor Guide`_.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Distributed under the terms of the `GNU GPL v3.0 license`_,
|
||||
*APRSD Weewx Plugin* is free and open source software.
|
||||
|
||||
|
||||
Issues
|
||||
------
|
||||
|
||||
If you encounter any problems,
|
||||
please `file an issue`_ along with a detailed description.
|
||||
|
||||
|
||||
Credits
|
||||
-------
|
||||
|
||||
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
|
||||
This project was generated from `@hemna`_'s `APRSD Plugin Python Cookiecutter`_ template.
|
||||
|
||||
.. _@hemna: https://github.com/hemna
|
||||
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
|
||||
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
|
||||
.. _GNU GPL v3.0 license: https://opensource.org/licenses/GNU GPL v3.0
|
||||
.. _PyPI: https://pypi.org/
|
||||
.. _APRSD Plugin Python Cookiecutter: https://github.com/hemna/cookiecutter-aprsd-plugin
|
||||
.. _file an issue: https://github.com/hemna/aprsd-weewx-plugin/issues
|
||||
.. _pip: https://pip.pypa.io/
|
||||
.. github-only
|
||||
.. _Contributor Guide: CONTRIBUTING.rst
|
||||
.. _Usage: https://aprsd-weewx-plugin.readthedocs.io/en/latest/usage.html
|
||||
|
|
|
@ -1,5 +1,16 @@
|
|||
"""Top-level package for aprsd_weewx_plugin."""
|
||||
# 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.
|
||||
|
||||
__author__ = """Walter A. Boring IV"""
|
||||
__email__ = "waboring@hemna.com"
|
||||
__version__ = "0.1.0"
|
||||
import pbr.version
|
||||
|
||||
|
||||
__version__ = pbr.version.VersionInfo("aprsd_weewx_plugin").version_string()
|
||||
|
|
|
@ -1,161 +0,0 @@
|
|||
"""Main module."""
|
||||
import datetime
|
||||
import json
|
||||
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:
|
||||
LOG.info("Looking for weewx.mqtt.host config entry")
|
||||
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:
|
||||
LOG.info("Creating WeewxMQTTThread")
|
||||
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 = None
|
||||
LOG.info("Looking for a message")
|
||||
if not mqtt_queue.empty():
|
||||
msg = mqtt_queue.get(timeout=1)
|
||||
else:
|
||||
msg = mqtt_queue.get(timeout=30)
|
||||
|
||||
if not msg:
|
||||
return "No Weewx data"
|
||||
else:
|
||||
LOG.info(f"Got a message {msg}")
|
||||
# Wants format of 71.5F/54.0F Wind 1@49G7 54%
|
||||
if "outTemp_F" in msg:
|
||||
temperature = "{:0.2f}F".format(float(msg["outTemp_F"]))
|
||||
dewpoint = "{:0.2f}F".format(float(msg["dewpoint_F"]))
|
||||
else:
|
||||
temperature = "{:0.2f}C".format(float(msg["outTemp_C"]))
|
||||
dewpoint = "{:0.2f}C".format(float(msg["dewpoint_C"]))
|
||||
|
||||
wind_direction = "{:0.0f}".format(float(msg["windDir"]))
|
||||
if "windSpeed_mps" in msg:
|
||||
wind_speed = "{:0.0f}".format(float(msg["windSpeed_mps"]))
|
||||
wind_gust = "{:0.0f}".format(float(msg["windGust_mps"]))
|
||||
else:
|
||||
wind_speed = "{:0.0f}".format(float(msg["windSpeed_mph"]))
|
||||
wind_gust = "{:0.0f}".format(float(msg["windGust_mph"]))
|
||||
|
||||
wind = "{}@{}G{}".format(
|
||||
wind_speed,
|
||||
wind_direction,
|
||||
wind_gust,
|
||||
)
|
||||
|
||||
humidity = "{:0.0f}%".format(float(msg["outHumidity"]))
|
||||
|
||||
ts = int("{:0.0f}".format(float(msg["dateTime"])))
|
||||
ts = datetime.datetime.fromtimestamp(ts)
|
||||
|
||||
wx = "{} {}/{} Wind {} {}".format(
|
||||
ts,
|
||||
temperature,
|
||||
dewpoint,
|
||||
wind,
|
||||
humidity,
|
||||
)
|
||||
LOG.debug(
|
||||
"Got weather {} -- len {}".format(
|
||||
wx,
|
||||
len(wx),
|
||||
),
|
||||
)
|
||||
return wx
|
||||
|
||||
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):
|
||||
LOG.info("Creating mqtt client")
|
||||
self._mqtt_host = self.config["services"]["weewx"]["mqtt"]["host"]
|
||||
self._mqtt_port = self.config["services"]["weewx"]["mqtt"]["port"]
|
||||
self._mqtt_user = self.config["services"]["weewx"]["mqtt"]["user"]
|
||||
self._mqtt_pass = self.config["services"]["weewx"]["mqtt"]["password"]
|
||||
LOG.info(
|
||||
"Connecting to mqtt {}:XXXX@{}:{}".format(
|
||||
self._mqtt_user,
|
||||
self._mqtt_host,
|
||||
self._mqtt_port,
|
||||
),
|
||||
)
|
||||
self.client = mqtt.Client(client_id="WeewxMQTTPlugin")
|
||||
self.client.on_connect = self.on_connect
|
||||
self.client.on_message = self.on_message
|
||||
self.client.connect(self._mqtt_host, self._mqtt_port, 60)
|
||||
self.client.username_pw_set(username="hemna", password="ass")
|
||||
|
||||
def on_connect(self, client, userdata, flags, rc):
|
||||
LOG.info(f"Connected to MQTT {self._mqtt_host} ({rc})")
|
||||
client.subscribe("weather/loop")
|
||||
|
||||
def on_message(self, client, userdata, msg):
|
||||
wx_data = json.loads(msg.payload)
|
||||
LOG.debug(f"Got WX data {wx_data}")
|
||||
mqtt_queue.put(wx_data)
|
||||
|
||||
def stop(self):
|
||||
LOG.info("calling disconnect")
|
||||
self.thread_stop = True
|
||||
self.client.disconnect()
|
||||
|
||||
def loop(self):
|
||||
LOG.info("Looping bitch")
|
||||
self.client.loop_forever()
|
||||
return True
|
|
@ -0,0 +1,7 @@
|
|||
from oslo_config import cfg
|
||||
|
||||
from aprsd_weewx_plugin.conf import weewx
|
||||
|
||||
|
||||
CONF = cfg.CONF
|
||||
weewx.register_opts(CONF)
|
|
@ -0,0 +1,80 @@
|
|||
# Copyright 2015 OpenStack Foundation
|
||||
# All Rights Reserved.
|
||||
#
|
||||
# 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.
|
||||
|
||||
"""
|
||||
This is the single point of entry to generate the sample configuration
|
||||
file for Nova. It collects all the necessary info from the other modules
|
||||
in this package. It is assumed that:
|
||||
|
||||
* every other module in this package has a 'list_opts' function which
|
||||
return a dict where
|
||||
* the keys are strings which are the group names
|
||||
* the value of each key is a list of config options for that group
|
||||
* the nova.conf package doesn't have further packages with config options
|
||||
* this module is only used in the context of sample file generation
|
||||
"""
|
||||
|
||||
import collections
|
||||
import importlib
|
||||
import os
|
||||
import pkgutil
|
||||
|
||||
|
||||
LIST_OPTS_FUNC_NAME = "list_opts"
|
||||
|
||||
|
||||
def _tupleize(dct):
|
||||
"""Take the dict of options and convert to the 2-tuple format."""
|
||||
return [(key, val) for key, val in dct.items()]
|
||||
|
||||
|
||||
def list_opts():
|
||||
opts = collections.defaultdict(list)
|
||||
module_names = _list_module_names()
|
||||
imported_modules = _import_modules(module_names)
|
||||
_append_config_options(imported_modules, opts)
|
||||
return _tupleize(opts)
|
||||
|
||||
|
||||
def _list_module_names():
|
||||
module_names = []
|
||||
package_path = os.path.dirname(os.path.abspath(__file__))
|
||||
for _, modname, ispkg in pkgutil.iter_modules(path=[package_path]):
|
||||
if modname == "opts" or ispkg:
|
||||
continue
|
||||
else:
|
||||
module_names.append(modname)
|
||||
return module_names
|
||||
|
||||
|
||||
def _import_modules(module_names):
|
||||
imported_modules = []
|
||||
for modname in module_names:
|
||||
mod = importlib.import_module("aprsd_weewx_plugin.conf." + modname)
|
||||
if not hasattr(mod, LIST_OPTS_FUNC_NAME):
|
||||
msg = "The module 'aprsd_weewx_plugin.conf.%s' should have a '%s' "\
|
||||
"function which returns the config options." % \
|
||||
(modname, LIST_OPTS_FUNC_NAME)
|
||||
raise Exception(msg)
|
||||
else:
|
||||
imported_modules.append(mod)
|
||||
return imported_modules
|
||||
|
||||
|
||||
def _append_config_options(imported_modules, config_options):
|
||||
for mod in imported_modules:
|
||||
configs = mod.list_opts()
|
||||
for key, val in configs.items():
|
||||
config_options[key].extend(val)
|
|
@ -0,0 +1,62 @@
|
|||
from oslo_config import cfg
|
||||
|
||||
|
||||
weewx_group = cfg.OptGroup(
|
||||
name="aprsd_weewx_plugin",
|
||||
title="APRSD Weewx Plugin settings",
|
||||
)
|
||||
|
||||
weewx_opts = [
|
||||
cfg.FloatOpt(
|
||||
"latitude",
|
||||
default=None,
|
||||
help="Latitude of the station you want to report as",
|
||||
),
|
||||
cfg.FloatOpt(
|
||||
"longitude",
|
||||
default=None,
|
||||
help="Longitude of the station you want to report as",
|
||||
),
|
||||
cfg.IntOpt(
|
||||
"report_interval",
|
||||
default=60,
|
||||
help="How long (in seconds) in between weather reports",
|
||||
),
|
||||
]
|
||||
|
||||
weewx_mqtt_opts = [
|
||||
cfg.StrOpt(
|
||||
"mqtt_user",
|
||||
help="MQTT username",
|
||||
),
|
||||
cfg.StrOpt(
|
||||
"mqtt_password",
|
||||
secret=True,
|
||||
help="MQTT password",
|
||||
),
|
||||
cfg.StrOpt(
|
||||
"mqtt_host",
|
||||
help="MQTT Hostname to connect to",
|
||||
),
|
||||
cfg.PortOpt(
|
||||
"mqtt_port",
|
||||
help="MQTT Port",
|
||||
),
|
||||
]
|
||||
|
||||
ALL_OPTS = (
|
||||
weewx_opts +
|
||||
weewx_mqtt_opts
|
||||
)
|
||||
|
||||
|
||||
def register_opts(cfg):
|
||||
cfg.register_group(weewx_group)
|
||||
cfg.register_opts(ALL_OPTS, group=weewx_group)
|
||||
|
||||
|
||||
def list_opts():
|
||||
register_opts(cfg.CONF)
|
||||
return {
|
||||
weewx_group.name: ALL_OPTS,
|
||||
}
|
|
@ -0,0 +1,369 @@
|
|||
"""Main module."""
|
||||
import datetime
|
||||
import json
|
||||
import logging
|
||||
import queue
|
||||
import time
|
||||
|
||||
import aprsd.messaging
|
||||
import paho.mqtt.client as mqtt
|
||||
from aprsd import plugin, threads
|
||||
from aprsd.threads import tx
|
||||
from oslo_config import cfg
|
||||
|
||||
from aprsd_weewx_plugin import conf # noqa
|
||||
|
||||
|
||||
CONF = cfg.CONF
|
||||
LOG = logging.getLogger("APRSD")
|
||||
|
||||
|
||||
class ClearableQueue(queue.Queue):
|
||||
|
||||
def clear(self):
|
||||
try:
|
||||
while True:
|
||||
self.get_nowait()
|
||||
except queue.Empty:
|
||||
pass
|
||||
|
||||
|
||||
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."""
|
||||
self.enabled = True
|
||||
if not CONF.aprsd_weewx_plugin.mqtt_host:
|
||||
LOG.error("aprsd_weewx_plugin.mqtt_host is not set in config!")
|
||||
self.enabled = False
|
||||
|
||||
if not CONF.aprsd_weewx_plugin.mqtt_user:
|
||||
LOG.warning("aprsd_weewx_plugin.mqtt_user is not set")
|
||||
if not CONF.aprsd_weewx_plugin.mqtt_password:
|
||||
LOG.warning("aprsd_weewx_plugin.mqtt_password is not set")
|
||||
|
||||
def create_threads(self):
|
||||
if self.enabled:
|
||||
LOG.info("Creating WeewxMQTTThread")
|
||||
self.queue = ClearableQueue(maxsize=1)
|
||||
self.wx_queue = ClearableQueue(maxsize=1)
|
||||
mqtt_thread = WeewxMQTTThread(
|
||||
wx_queue=self.wx_queue,
|
||||
msg_queue=self.queue,
|
||||
)
|
||||
threads = [mqtt_thread]
|
||||
|
||||
# if we have position and a callsign to report
|
||||
# Then we can periodically report weather data
|
||||
# to APRS
|
||||
if (
|
||||
CONF.aprsd_weewx_plugin.latitude and
|
||||
CONF.aprsd_weewx_plugin.longitude
|
||||
):
|
||||
LOG.info("Creating WeewxWXAPRSThread")
|
||||
wx_thread = WeewxWXAPRSThread(
|
||||
wx_queue=self.wx_queue,
|
||||
)
|
||||
threads.append(wx_thread)
|
||||
else:
|
||||
LOG.info(
|
||||
"NOT starting Weewx WX APRS Thread due to missing "
|
||||
"GPS location settings. Please set "
|
||||
"aprsd_weewx_plugin.latitude and "
|
||||
"aprsd_weewx_plugin.longitude to start reporting as an "
|
||||
"aprs weather station.",
|
||||
)
|
||||
|
||||
return threads
|
||||
else:
|
||||
LOG.info("WeewxMQTTPlugin not enabled due to missing config.")
|
||||
|
||||
def process(self, packet):
|
||||
LOG.info("WeewxMQTT Plugin")
|
||||
packet.get("from")
|
||||
packet.get("message_text", None)
|
||||
# ack = packet.get("msgNo", "0")
|
||||
|
||||
# see if there are any weather messages in the queue.
|
||||
msg = None
|
||||
LOG.info("Looking for a message")
|
||||
if not self.queue.empty():
|
||||
msg = self.queue.get(timeout=1)
|
||||
else:
|
||||
try:
|
||||
msg = self.queue.get(timeout=30)
|
||||
except Exception:
|
||||
return "No Weewx Data"
|
||||
|
||||
if not msg:
|
||||
return "No Weewx data"
|
||||
else:
|
||||
LOG.info(f"Got a message {msg}")
|
||||
# Wants format of 71.5F/54.0F Wind 1@49G7 54%
|
||||
if "outTemp_F" in msg:
|
||||
temperature = "{:0.2f}F".format(float(msg["outTemp_F"]))
|
||||
dewpoint = "{:0.2f}F".format(float(msg["dewpoint_F"]))
|
||||
else:
|
||||
temperature = "{:0.2f}C".format(float(msg["outTemp_C"]))
|
||||
dewpoint = "{:0.2f}C".format(float(msg["dewpoint_C"]))
|
||||
|
||||
wind_direction = "{:0.0f}".format(float(msg.get("windDir", 0)))
|
||||
LOG.info(f"wind direction {wind_direction}")
|
||||
if "windSpeed_mps" in msg:
|
||||
wind_speed = "{:0.0f}".format(float(msg["windSpeed_mps"]))
|
||||
wind_gust = "{:0.0f}".format(float(msg["windGust_mps"]))
|
||||
else:
|
||||
wind_speed = "{:0.0f}".format(float(msg["windSpeed_mph"]))
|
||||
wind_gust = "{:0.0f}".format(float(msg["windGust_mph"]))
|
||||
|
||||
wind = "{}@{}G{}".format(
|
||||
wind_speed,
|
||||
wind_direction,
|
||||
wind_gust,
|
||||
)
|
||||
|
||||
humidity = "{:0.0f}%".format(float(msg["outHumidity"]))
|
||||
|
||||
ts = int("{:0.0f}".format(float(msg["dateTime"])))
|
||||
ts = datetime.datetime.fromtimestamp(ts)
|
||||
|
||||
# do rain in format of last hour/day/month/year
|
||||
|
||||
rain = "RA {:.2f} {:.2f}/hr".format(
|
||||
float(msg.get("dayRain_in", 0.00)),
|
||||
float(msg.get("rainRate_inch_per_hour", 0.00)),
|
||||
)
|
||||
|
||||
wx = "WX: {}/{} Wind {} {} {} {:.2f}inHg".format(
|
||||
temperature,
|
||||
dewpoint,
|
||||
wind,
|
||||
humidity,
|
||||
rain,
|
||||
float(msg.get("pressure_inHg", 0.00)),
|
||||
)
|
||||
LOG.debug(
|
||||
"Got weather {} -- len {}".format(
|
||||
wx,
|
||||
len(wx),
|
||||
),
|
||||
)
|
||||
return wx
|
||||
|
||||
|
||||
class WeewxMQTTThread(threads.APRSDThread):
|
||||
_mqtt_host = None
|
||||
_mqtt_port = None
|
||||
client = None
|
||||
|
||||
def __init__(self, wx_queue, msg_queue):
|
||||
super().__init__("WeewxMQTTThread")
|
||||
self.msg_queue = msg_queue
|
||||
self.wx_queue = wx_queue
|
||||
self.setup()
|
||||
|
||||
def setup(self):
|
||||
LOG.info("Creating mqtt client")
|
||||
self._mqtt_host = CONF.aprsd_weewx_plugin.mqtt_host
|
||||
self._mqtt_port = CONF.aprsd_weewx_plugin.mqtt_port
|
||||
LOG.info(
|
||||
"Connecting to mqtt {}:{}".format(
|
||||
self._mqtt_host,
|
||||
self._mqtt_port,
|
||||
),
|
||||
)
|
||||
self.client = mqtt.Client(client_id="WeewxMQTTPlugin")
|
||||
self.client.on_connect = self.on_connect
|
||||
self.client.on_message = self.on_message
|
||||
self.client.connect(self._mqtt_host, self._mqtt_port, 60)
|
||||
if CONF.aprsd_weewx_plugin.mqtt_user:
|
||||
username = CONF.aprsd_weewx_plugin.mqtt_user
|
||||
password = CONF.aprsd_weewx_plugin.mqtt_password
|
||||
LOG.info(f"Using MQTT username/password {username}/XXXXXX")
|
||||
self.client.username_pw_set(
|
||||
username=username,
|
||||
password=password,
|
||||
)
|
||||
else:
|
||||
LOG.info("Not using MQTT username/password")
|
||||
|
||||
def on_connect(self, client, userdata, flags, rc):
|
||||
LOG.info(f"Connected to MQTT {self._mqtt_host} ({rc})")
|
||||
client.subscribe("weather/loop")
|
||||
|
||||
def on_message(self, client, userdata, msg):
|
||||
wx_data = json.loads(msg.payload)
|
||||
LOG.debug("Got WX data")
|
||||
# Make sure we have only 1 item in the queue
|
||||
if self.msg_queue.qsize() >= 1:
|
||||
self.msg_queue.clear()
|
||||
self.msg_queue.put(wx_data)
|
||||
self.wx_queue.clear()
|
||||
self.wx_queue.put(wx_data)
|
||||
|
||||
def stop(self):
|
||||
LOG.info(__class__.__name__+" Stop")
|
||||
self.thread_stop = True
|
||||
LOG.info("Stopping loop")
|
||||
self.client.loop_stop()
|
||||
LOG.info("Disconnecting from MQTT")
|
||||
self.client.disconnect()
|
||||
|
||||
def loop(self):
|
||||
LOG.info("Loop")
|
||||
self.client.loop_forever()
|
||||
# self.client.loop(timeout=10, max_packets=10)
|
||||
return True
|
||||
|
||||
|
||||
class WeewxWXAPRSThread(threads.APRSDThread):
|
||||
def __init__(self, wx_queue):
|
||||
super().__init__(self.__class__.__name__)
|
||||
self.wx_queue = wx_queue
|
||||
self.latitude = CONF.aprsd_weewx_plugin.latitude
|
||||
self.longitude = CONF.aprsd_weewx_plugin.longitude
|
||||
self.callsign = CONF.callsign
|
||||
self.report_interval = CONF.aprsd_weewx_plugin.report_interval
|
||||
self.last_send = datetime.datetime.now()
|
||||
|
||||
if self.latitude and self.longitude:
|
||||
self.position = self.get_latlon(
|
||||
float(self.latitude),
|
||||
float(self.longitude),
|
||||
)
|
||||
|
||||
def decdeg2dmm_m(self, degrees_decimal):
|
||||
is_positive = degrees_decimal >= 0
|
||||
degrees_decimal = abs(degrees_decimal)
|
||||
minutes, seconds = divmod(degrees_decimal * 3600, 60)
|
||||
degrees, minutes = divmod(minutes, 60)
|
||||
degrees = degrees if is_positive else -degrees
|
||||
|
||||
# degrees = str(int(degrees)).zfill(2).replace("-", "0")
|
||||
degrees = abs(int(degrees))
|
||||
# minutes = str(round(minutes + (seconds / 60), 2)).zfill(5)
|
||||
minutes = int(round(minutes + (seconds / 60), 2))
|
||||
hundredths = round(seconds / 60, 2)
|
||||
|
||||
return {
|
||||
"degrees": degrees, "minutes": minutes, "seconds": seconds,
|
||||
"hundredths": hundredths,
|
||||
}
|
||||
|
||||
def convert_latitude(self, degrees_decimal):
|
||||
det = self.decdeg2dmm_m(degrees_decimal)
|
||||
if degrees_decimal > 0:
|
||||
direction = "N"
|
||||
else:
|
||||
direction = "S"
|
||||
|
||||
degrees = str(det.get("degrees")).zfill(2)
|
||||
minutes = str(det.get("minutes")).zfill(2)
|
||||
det.get("seconds")
|
||||
hundredths = str(det.get("hundredths")).split(".")[1]
|
||||
lat = f"{degrees}{str(minutes)}.{hundredths}{direction}"
|
||||
return lat
|
||||
|
||||
def convert_longitude(self, degrees_decimal):
|
||||
det = self.decdeg2dmm_m(degrees_decimal)
|
||||
if degrees_decimal > 0:
|
||||
direction = "E"
|
||||
else:
|
||||
direction = "W"
|
||||
|
||||
degrees = str(det.get("degrees")).zfill(3)
|
||||
minutes = str(det.get("minutes")).zfill(2)
|
||||
det.get("seconds")
|
||||
hundredths = str(det.get("hundredths")).split(".")[1]
|
||||
lon = f"{degrees}{str(minutes)}.{hundredths}{direction}"
|
||||
return lon
|
||||
|
||||
def get_latlon(self, latitude_str, longitude_str):
|
||||
return "{}/{}_".format(
|
||||
self.convert_latitude(float(latitude_str)),
|
||||
self.convert_longitude(float(longitude_str)),
|
||||
)
|
||||
|
||||
def str_or_dots(self, number, length):
|
||||
# If parameter is None, fill with dots, otherwise pad with zero
|
||||
# if not number:
|
||||
# retn_value = "." * length
|
||||
# else:
|
||||
format_type = {"int": "d", "float": ".0f"}[type(number).__name__]
|
||||
retn_value = "".join(("%0", str(length), format_type)) % number
|
||||
|
||||
return retn_value
|
||||
|
||||
def build_wx_packet(self, wx_data):
|
||||
wind_dir = float(wx_data.get("windDir", 0.00))
|
||||
wind_speed = float(wx_data.get("windSpeed_mph", 0.00))
|
||||
wind_gust = float(wx_data.get("windGust_mph", 0.00))
|
||||
temperature = float(wx_data.get("outTemp_F", 0.00))
|
||||
rain_last_hr = float(wx_data.get("hourRain_in", 0.00))
|
||||
rain_last_24_hrs = float(wx_data.get("rain24_in", 0.00))
|
||||
rain_since_midnight = float(wx_data.get("day_Rain_in", 0.00))
|
||||
humidity = float(wx_data.get("outHumidity", 0.00))
|
||||
# * 330.863886667
|
||||
# inHg * 33.8639 = mBar
|
||||
pressure = float(wx_data.get("pressure_inHg", 0.00)) * 33.8639 * 10
|
||||
return aprsd.packets.WeatherPacket(
|
||||
from_call=self.callsign,
|
||||
to_call="APRS",
|
||||
latitude=self.convert_latitude(float(self.latitude)),
|
||||
longitude=self.convert_longitude(float(self.longitude)),
|
||||
wind_direction=int(wind_dir),
|
||||
wind_speed=wind_speed,
|
||||
wind_gust=wind_gust,
|
||||
temperature=temperature,
|
||||
rain_1h=rain_last_hr,
|
||||
rain_24h=rain_last_24_hrs,
|
||||
rain_since_midnight=rain_since_midnight,
|
||||
humidity=int(round(humidity)),
|
||||
pressure=pressure,
|
||||
comment="APRSD WX http://pypi.org/project/aprsd",
|
||||
)
|
||||
|
||||
def loop(self):
|
||||
now = datetime.datetime.now()
|
||||
delta = now - self.last_send
|
||||
max_timeout = {"seconds": self.report_interval}
|
||||
max_delta = datetime.timedelta(**max_timeout)
|
||||
if delta >= max_delta:
|
||||
if not self.wx_queue.empty():
|
||||
wx = self.wx_queue.get(timeout=1)
|
||||
else:
|
||||
try:
|
||||
wx = self.wx_queue.get(timeout=5)
|
||||
except Exception:
|
||||
time.sleep(1)
|
||||
return True
|
||||
|
||||
if not wx:
|
||||
# just keep looping
|
||||
time.sleep(1)
|
||||
return True
|
||||
|
||||
# we have Weather now, so lets format the data
|
||||
# and then send it out to APRS
|
||||
packet = self.build_wx_packet(wx)
|
||||
packet.retry_count = 1
|
||||
tx.send(packet)
|
||||
self.last_send = datetime.datetime.now()
|
||||
time.sleep(1)
|
||||
return True
|
||||
else:
|
||||
time.sleep(1)
|
||||
return True
|
|
@ -0,0 +1,22 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
"""Removes temporary Sphinx build artifacts to ensure a clean build.
|
||||
|
||||
This is needed if the Python source being documented changes significantly. Old sphinx-apidoc
|
||||
RST files can be left behind.
|
||||
"""
|
||||
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def main() -> None:
|
||||
docs_dir = Path(__file__).resolve().parent
|
||||
for folder in ("_build", "apidoc"):
|
||||
delete_dir = docs_dir / folder
|
||||
if delete_dir.exists():
|
||||
shutil.rmtree(delete_dir)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
58
docs/conf.py
58
docs/conf.py
|
@ -19,10 +19,13 @@
|
|||
#
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
|
||||
|
||||
sys.path.insert(0, os.path.abspath(".."))
|
||||
|
||||
import aprsd_weewx_plugin
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
|
@ -31,22 +34,22 @@ import aprsd_weewx_plugin
|
|||
|
||||
# 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']
|
||||
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
|
||||
|
||||
# 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 master toctree document.
|
||||
master_doc = 'index'
|
||||
master_doc = "index"
|
||||
|
||||
# General information about the project.
|
||||
project = 'aprsd_weewx_plugin'
|
||||
project = "APRSD Weewx Plugin "
|
||||
copyright = "2021, Walter A. Boring IV"
|
||||
author = "Walter A. Boring IV"
|
||||
|
||||
|
@ -69,10 +72,10 @@ 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']
|
||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||
|
||||
# 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
|
||||
|
@ -83,7 +86,7 @@ todo_include_todos = False
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
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
|
||||
|
@ -94,13 +97,13 @@ html_theme = 'alabaster'
|
|||
# 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"]
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ---------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'aprsd_weewx_plugindoc'
|
||||
htmlhelp_basename = "aprsd_weewx_plugindoc"
|
||||
|
||||
|
||||
# -- Options for LaTeX output ------------------------------------------
|
||||
|
@ -127,9 +130,11 @@ latex_elements = {
|
|||
# (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'),
|
||||
(
|
||||
master_doc, "aprsd_weewx_plugin.tex",
|
||||
"APRSD Weewx Plugin Documentation",
|
||||
"Walter A. Boring IV", "manual",
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
|
@ -138,9 +143,11 @@ latex_documents = [
|
|||
# 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)
|
||||
(
|
||||
master_doc, "aprsd_weewx_plugin",
|
||||
"APRSD Weewx Plugin Documentation",
|
||||
[author], 1,
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
|
@ -150,13 +157,12 @@ man_pages = [
|
|||
# (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'),
|
||||
(
|
||||
master_doc, "aprsd_weewx_plugin",
|
||||
"APRSD Weewx Plugin Documentation",
|
||||
author,
|
||||
"aprsd_weewx_plugin",
|
||||
"One line description of project.",
|
||||
"Miscellaneous",
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
Welcome to aprsd_weewx_plugin's documentation!
|
||||
======================================
|
||||
Welcome to APRSD Nearest station plugin's documentation!
|
||||
========================================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
@ -7,8 +7,6 @@ Welcome to aprsd_weewx_plugin's documentation!
|
|||
|
||||
readme
|
||||
installation
|
||||
usage
|
||||
modules
|
||||
contributing
|
||||
authors
|
||||
history
|
||||
|
|
|
@ -8,13 +8,13 @@ Installation
|
|||
Stable release
|
||||
--------------
|
||||
|
||||
To install aprsd_weewx_plugin, run this command in your terminal:
|
||||
To install aprsd-weewx-plugin, run this command in your terminal:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install aprsd_weewx_plugin
|
||||
$ 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.
|
||||
This is the preferred method to install, 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.
|
||||
|
@ -26,19 +26,19 @@ you through the process.
|
|||
From sources
|
||||
------------
|
||||
|
||||
The sources for aprsd_weewx_plugin can be downloaded from the `Github repo`_.
|
||||
The sources 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
|
||||
$ 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
|
||||
$ curl -OJL https://github.com/hemna/aprsd-weewx-plugin/tarball/master
|
||||
|
||||
Once you have a copy of the source, you can install it with:
|
||||
|
||||
|
@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
|
|||
$ python setup.py install
|
||||
|
||||
|
||||
.. _Github repo: https://github.com/hemna/aprsd_weewx_plugin
|
||||
.. _tarball: https://github.com/hemna/aprsd_weewx_plugin/tarball/master
|
||||
.. _Github repo: https://github.com/hemna/aprsd-weewx-plugin
|
||||
.. _tarball: https://github.com/hemna/aprsd-weewx-plugin/tarball/master
|
||||
|
|
|
@ -1,36 +0,0 @@
|
|||
@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
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../README.rst
|
|
@ -1,7 +0,0 @@
|
|||
=====
|
||||
Usage
|
||||
=====
|
||||
|
||||
To use aprsd_weewx_plugin in a project::
|
||||
|
||||
import aprsd_weewx_plugin
|
|
@ -1,4 +1,4 @@
|
|||
pbr
|
||||
aprsd>=2.1.0
|
||||
requests
|
||||
aprsd>=3.0.0
|
||||
paho-mqtt
|
||||
oslo-config
|
||||
|
|
10
setup.cfg
10
setup.cfg
|
@ -4,7 +4,10 @@ long_description = file: README.rst
|
|||
long_description_content_type = text/x-rst
|
||||
author = Walter A. Boring IV
|
||||
author_email = waboring@hemna.com
|
||||
license = GPL-3.0
|
||||
license_file = LICENSE
|
||||
classifiers =
|
||||
License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
||||
classifier =
|
||||
Topic :: Communications :: Ham Radio
|
||||
Operating System :: POSIX :: Linux
|
||||
|
@ -14,11 +17,12 @@ classifier =
|
|||
Programming Language :: Python :: 3.9
|
||||
description_file =
|
||||
README.rst
|
||||
project_urls =
|
||||
Source=https://github.com/hemna/aprsd-weewx-plugin
|
||||
Tracker=https://github.com/hemna/aprsd-weewx-plugin/issues
|
||||
summary = HAM Radio APRSD that reports weather from a weewx weather station.
|
||||
|
||||
[options.entry_points]
|
||||
oslo.config.opts =
|
||||
aprsd_weewx_plugin.conf = aprsd_weewx_plugin.conf.opts:list_opts
|
||||
|
||||
[global]
|
||||
setup-hooks =
|
||||
pbr.hooks.setup_hook
|
||||
|
|
1
setup.py
1
setup.py
|
@ -15,6 +15,7 @@
|
|||
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
|
||||
import setuptools
|
||||
|
||||
|
||||
# In python < 2.7.4, a lazy loading of package `pbr` will break
|
||||
# setuptools if some other modules registered functions in `atexit`.
|
||||
# solution from: http://bugs.python.org/issue15881#msg170215
|
||||
|
|
Loading…
Reference in New Issue