mirror of
https://github.com/hemna/aprsd-stock-plugin.git
synced 2025-02-03 09:44:01 -05:00
Initial commit
This commit is contained in:
commit
0e1ac06fb8
23
.pre-commit-config.yaml
Normal file
23
.pre-commit-config.yaml
Normal file
@ -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
|
||||||
202
LICENSE
Normal file
202
LICENSE
Normal file
@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright {yyyy} {name of copyright owner}
|
||||||
|
|
||||||
|
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.
|
||||||
65
Makefile
Normal file
65
Makefile
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
REQUIREMENTS_TXT ?= requirements.txt requirements-dev.txt
|
||||||
|
.DEFAULT_GOAL := help
|
||||||
|
|
||||||
|
.PHONY: help dev test
|
||||||
|
include Makefile.venv
|
||||||
|
Makefile.venv:
|
||||||
|
curl \
|
||||||
|
-o Makefile.fetched \
|
||||||
|
-L "https://github.com/sio/Makefile.venv/raw/v2020.08.14/Makefile.venv"
|
||||||
|
echo "5afbcf51a82f629cd65ff23185acde90ebe4dec889ef80bbdc12562fbd0b2611 *Makefile.fetched" \
|
||||||
|
| sha256sum --check - \
|
||||||
|
&& mv Makefile.fetched Makefile.venv
|
||||||
|
|
||||||
|
help: # Help for the Makefile
|
||||||
|
@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
|
||||||
|
|
||||||
|
dev: venv ## Create the virtualenv with all the requirements installed
|
||||||
|
|
||||||
|
docs: build
|
||||||
|
cp README.rst docs/readme.rst
|
||||||
|
cp Changelog docs/changelog.rst
|
||||||
|
tox -edocs
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
coverage: ## check code coverage quickly with the default Python
|
||||||
|
coverage run --source aprsd_stock_plugin setup.py test
|
||||||
|
coverage report -m
|
||||||
|
coverage html
|
||||||
|
$(BROWSER) htmlcov/index.html
|
||||||
|
|
||||||
|
test: dev ## Run all the tox tests
|
||||||
|
tox -p all
|
||||||
|
|
||||||
|
build: test ## Make the build artifact prior to doing an upload
|
||||||
|
$(VENV)/python3 setup.py sdist bdist_wheel
|
||||||
|
$(VENV)/twine check dist/*
|
||||||
|
|
||||||
|
upload: build ## Upload a new version of the plugin
|
||||||
|
$(VENV)/twine upload dist/*
|
||||||
|
|
||||||
|
check: dev ## Code format check with tox and pep8
|
||||||
|
tox -epep8
|
||||||
|
|
||||||
|
fix: dev ## fixes code formatting with gray
|
||||||
|
tox -efmt
|
||||||
99
README.rst
Normal file
99
README.rst
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
APRSD Yahoo Finance Stock Quotes
|
||||||
|
================================
|
||||||
|
|
||||||
|
|PyPI| |Status| |Python Version| |License|
|
||||||
|
|
||||||
|
|Read the Docs| |Tests| |Codecov|
|
||||||
|
|
||||||
|
|pre-commit|
|
||||||
|
|
||||||
|
.. |PyPI| image:: https://img.shields.io/pypi/v/aprsd-stock-plugin.svg
|
||||||
|
:target: https://pypi.org/project/aprsd-stock-plugin/
|
||||||
|
:alt: PyPI
|
||||||
|
.. |Status| image:: https://img.shields.io/pypi/status/aprsd-stock-plugin.svg
|
||||||
|
:target: https://pypi.org/project/aprsd-stock-plugin/
|
||||||
|
:alt: Status
|
||||||
|
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/aprsd-stock-plugin
|
||||||
|
:target: https://pypi.org/project/aprsd-stock-plugin
|
||||||
|
:alt: Python Version
|
||||||
|
.. |License| image:: https://img.shields.io/pypi/l/aprsd-stock-plugin
|
||||||
|
:target: https://opensource.org/licenses/Apache Software License 2.0
|
||||||
|
:alt: License
|
||||||
|
.. |Read the Docs| image:: https://img.shields.io/readthedocs/aprsd-stock-plugin/latest.svg?label=Read%20the%20Docs
|
||||||
|
:target: https://aprsd-stock-plugin.readthedocs.io/
|
||||||
|
:alt: Read the documentation at https://aprsd-stock-plugin.readthedocs.io/
|
||||||
|
.. |Tests| image:: https://github.com/hemna/aprsd-stock-plugin/workflows/Tests/badge.svg
|
||||||
|
:target: https://github.com/hemna/aprsd-stock-plugin/actions?workflow=Tests
|
||||||
|
:alt: Tests
|
||||||
|
.. |Codecov| image:: https://codecov.io/gh/hemna/aprsd-stock-plugin/branch/main/graph/badge.svg
|
||||||
|
:target: https://codecov.io/gh/hemna/aprsd-stock-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
|
||||||
|
--------
|
||||||
|
|
||||||
|
* TODO
|
||||||
|
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
|
||||||
|
* TODO
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
You can install *APRSD Yahoo Finance Stock Quotes* via pip_ from PyPI_:
|
||||||
|
|
||||||
|
.. code:: console
|
||||||
|
|
||||||
|
$ pip install aprsd-stock-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 `Apache Software License 2.0 license`_,
|
||||||
|
*APRSD Yahoo Finance Stock Quotes* is free and open source software.
|
||||||
|
|
||||||
|
|
||||||
|
Issues
|
||||||
|
------
|
||||||
|
|
||||||
|
If you encounter any problems,
|
||||||
|
please `file an issue`_ along with a detailed description.
|
||||||
|
|
||||||
|
|
||||||
|
Credits
|
||||||
|
-------
|
||||||
|
|
||||||
|
This project was generated from `@hemna`_'s `APRSD Plugin Python Cookiecutter`_ template.
|
||||||
|
|
||||||
|
.. _@hemna: https://github.com/hemna
|
||||||
|
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
|
||||||
|
.. _Apache Software License 2.0 license: https://opensource.org/licenses/Apache Software License 2.0
|
||||||
|
.. _PyPI: https://pypi.org/
|
||||||
|
.. _APRSD Plugin Python Cookiecutter: https://github.com/hemna/cookiecutter-aprsd-plugin
|
||||||
|
.. _file an issue: https://github.com/hemna/aprsd-stock-plugin/issues
|
||||||
|
.. _pip: https://pip.pypa.io/
|
||||||
|
.. github-only
|
||||||
|
.. _Contributor Guide: CONTRIBUTING.rst
|
||||||
|
.. _Usage: https://aprsd-stock-plugin.readthedocs.io/en/latest/usage.html
|
||||||
16
aprsd_stock_plugin/__init__.py
Normal file
16
aprsd_stock_plugin/__init__.py
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
# 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.
|
||||||
|
|
||||||
|
import pbr.version
|
||||||
|
|
||||||
|
|
||||||
|
__version__ = pbr.version.VersionInfo("aprsd_stock_plugin").version_string()
|
||||||
56
aprsd_stock_plugin/aprsd_stock_plugin.py
Normal file
56
aprsd_stock_plugin/aprsd_stock_plugin.py
Normal file
@ -0,0 +1,56 @@
|
|||||||
|
import logging
|
||||||
|
|
||||||
|
from aprsd import messaging, plugin, trace
|
||||||
|
|
||||||
|
import aprsd_stock_plugin
|
||||||
|
|
||||||
|
|
||||||
|
LOG = logging.getLogger("APRSD")
|
||||||
|
|
||||||
|
|
||||||
|
class YahooStockQuote(plugin.APRSDRegexCommandPluginBase):
|
||||||
|
|
||||||
|
version = aprsd_stock_plugin.__version__
|
||||||
|
# Look for any command that starts with w or W
|
||||||
|
command_regex = "^[wW]"
|
||||||
|
# the command is for ?
|
||||||
|
command_name = "weather"
|
||||||
|
|
||||||
|
enabled = False
|
||||||
|
|
||||||
|
def setup(self):
|
||||||
|
# Do some checks here?
|
||||||
|
self.enabled = True
|
||||||
|
|
||||||
|
def create_threads(self):
|
||||||
|
"""This allows you to create and return a custom APRSDThread object.
|
||||||
|
|
||||||
|
Create a child of the aprsd.threads.APRSDThread object and return it
|
||||||
|
It will automatically get started.
|
||||||
|
|
||||||
|
You can see an example of one here:
|
||||||
|
https://github.com/craigerl/aprsd/blob/master/aprsd/threads.py#L141
|
||||||
|
"""
|
||||||
|
if self.enabled:
|
||||||
|
# You can create a background APRSDThread object here
|
||||||
|
# Just return it for example:
|
||||||
|
# https://github.com/hemna/aprsd-weewx-plugin/blob/master/aprsd_weewx_plugin/aprsd_weewx_plugin.py#L42-L50
|
||||||
|
#
|
||||||
|
return []
|
||||||
|
|
||||||
|
@trace.trace
|
||||||
|
def process(self, packet):
|
||||||
|
|
||||||
|
"""This is called when a received packet matches self.command_regex."""
|
||||||
|
|
||||||
|
LOG.info("YahooStockQuote Plugin")
|
||||||
|
|
||||||
|
packet.get("from")
|
||||||
|
packet.get("message_text", None)
|
||||||
|
|
||||||
|
if self.enabled:
|
||||||
|
# Now we can process
|
||||||
|
return "some reply message"
|
||||||
|
else:
|
||||||
|
LOG.warning("YahooStockQuote is disabled.")
|
||||||
|
return messaging.NULL_MESSAGE
|
||||||
20
docs/Makefile
Normal file
20
docs/Makefile
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS =
|
||||||
|
SPHINXBUILD = python -msphinx
|
||||||
|
SPHINXPROJ = aprsd_stock_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)
|
||||||
1
docs/authors.rst
Normal file
1
docs/authors.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: ../AUTHORS.rst
|
||||||
22
docs/clean_docs.py
Normal file
22
docs/clean_docs.py
Normal file
@ -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()
|
||||||
168
docs/conf.py
Executable file
168
docs/conf.py
Executable file
@ -0,0 +1,168 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
# aprsd_stock_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_stock_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 Yahoo Finance Stock Quotes"
|
||||||
|
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_stock_plugin.__version__
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = aprsd_stock_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_stock_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_stock_plugin.tex",
|
||||||
|
"APRSD Yahoo Finance Stock Quotes 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_stock_plugin",
|
||||||
|
"APRSD Yahoo Finance Stock Quotes 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_stock_plugin",
|
||||||
|
"APRSD Yahoo Finance Stock Quotes Documentation",
|
||||||
|
author,
|
||||||
|
"aprsd_stock_plugin",
|
||||||
|
"One line description of project.",
|
||||||
|
"Miscellaneous",
|
||||||
|
),
|
||||||
|
]
|
||||||
1
docs/contributing.rst
Normal file
1
docs/contributing.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: ../CONTRIBUTING.rst
|
||||||
1
docs/history.rst
Normal file
1
docs/history.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: ../HISTORY.rst
|
||||||
18
docs/index.rst
Normal file
18
docs/index.rst
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
Welcome to APRSD Nearest station plugin's documentation!
|
||||||
|
========================================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: Contents:
|
||||||
|
|
||||||
|
readme
|
||||||
|
installation
|
||||||
|
contributing
|
||||||
|
authors
|
||||||
|
history
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
51
docs/installation.rst
Normal file
51
docs/installation.rst
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
.. highlight:: shell
|
||||||
|
|
||||||
|
============
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
|
||||||
|
Stable release
|
||||||
|
--------------
|
||||||
|
|
||||||
|
To install aprsd-stock-plugin, run this command in your terminal:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ pip install aprsd-stock-plugin
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
.. _pip: https://pip.pypa.io
|
||||||
|
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
|
||||||
|
|
||||||
|
|
||||||
|
From sources
|
||||||
|
------------
|
||||||
|
|
||||||
|
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-stock-plugin
|
||||||
|
|
||||||
|
Or download the `tarball`_:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ curl -OJL https://github.com/hemna/aprsd-stock-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-stock-plugin
|
||||||
|
.. _tarball: https://github.com/hemna/aprsd-stock-plugin/tarball/master
|
||||||
12
requirements-dev.txt
Normal file
12
requirements-dev.txt
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
pip
|
||||||
|
pip-tools
|
||||||
|
bump2version
|
||||||
|
wheel
|
||||||
|
watchdog
|
||||||
|
flake8
|
||||||
|
tox
|
||||||
|
coverage
|
||||||
|
Sphinx
|
||||||
|
twine
|
||||||
|
pytest==6.2.5
|
||||||
|
gray
|
||||||
2
requirements.txt
Normal file
2
requirements.txt
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
pbr
|
||||||
|
aprsd>=2.2.0
|
||||||
40
setup.cfg
Normal file
40
setup.cfg
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
[metadata]
|
||||||
|
name = aprsd_stock_plugin
|
||||||
|
long_description = file: README.rst
|
||||||
|
long_description_content_type = text/x-rst
|
||||||
|
author = Walter A. Boring IV
|
||||||
|
author_email = waboring@hemna.com
|
||||||
|
license = Apache-2.0
|
||||||
|
license_file = LICENSE
|
||||||
|
classifiers =
|
||||||
|
License :: OSI Approved :: Apache Software License
|
||||||
|
classifier =
|
||||||
|
Topic :: Communications :: Ham Radio
|
||||||
|
Operating System :: POSIX :: Linux
|
||||||
|
Programming Language :: Python
|
||||||
|
Programming Language :: Python :: 3.7
|
||||||
|
Programming Language :: Python :: 3.8
|
||||||
|
Programming Language :: Python :: 3.9
|
||||||
|
description_file =
|
||||||
|
README.rst
|
||||||
|
summary = Ham Radio APRSD Plugin for fetching stock quotes
|
||||||
|
|
||||||
|
[global]
|
||||||
|
setup-hooks =
|
||||||
|
pbr.hooks.setup_hook
|
||||||
|
|
||||||
|
[files]
|
||||||
|
packages =
|
||||||
|
aprsd_stock_plugin
|
||||||
|
|
||||||
|
[build_sphinx]
|
||||||
|
source-dir = doc/source
|
||||||
|
build-dir = doc/build
|
||||||
|
all_files = 1
|
||||||
|
|
||||||
|
[upload_sphinx]
|
||||||
|
upload-dir = doc/build/html
|
||||||
|
|
||||||
|
[mypy]
|
||||||
|
ignore_missing_imports = True
|
||||||
|
strict = True
|
||||||
27
setup.py
Normal file
27
setup.py
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
#
|
||||||
|
# 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 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
|
||||||
|
try:
|
||||||
|
import multiprocessing # noqa
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
setuptools.setup(setup_requires=["pbr"], pbr=True)
|
||||||
1
tests/__init__.py
Normal file
1
tests/__init__.py
Normal file
@ -0,0 +1 @@
|
|||||||
|
"""Unit test package for aprsd_stock_plugin."""
|
||||||
21
tests/test_aprsd_stock_plugin.py
Normal file
21
tests/test_aprsd_stock_plugin.py
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
"""Tests for `aprsd_stock_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
|
||||||
83
tox.ini
Normal file
83
tox.ini
Normal file
@ -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_stock_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_stock_plugin
|
||||||
|
sphinx-build -a -W . _build
|
||||||
|
|
||||||
|
[testenv:fmt]
|
||||||
|
skip_install = true
|
||||||
|
deps =
|
||||||
|
-r{toxinidir}/requirements-dev.txt
|
||||||
|
commands =
|
||||||
|
gray aprsd_stock_plugin tests
|
||||||
|
|
||||||
|
[testenv:licenses]
|
||||||
|
skip_install = true
|
||||||
|
recreate = true
|
||||||
|
deps =
|
||||||
|
-r{toxinidir}/requirements.txt
|
||||||
|
pip-licenses
|
||||||
|
commands =
|
||||||
|
pip-licenses {posargs}
|
||||||
Loading…
Reference in New Issue
Block a user