94 lines
2.9 KiB
ReStructuredText
94 lines
2.9 KiB
ReStructuredText
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
|
|
--------
|
|
|
|
* APRSD Plugin that gets a stock quote from Yahoo Finance python API and returns that.
|
|
|
|
|
|
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
|