ibyrd 0.0.1
ibyrd
License: MIT
Requires Python: >=3.7.9,<4.0.0

===============================
iByrd
===============================


|PyPI| |Python Version| |License|

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/ibyrd.svg
   :target: https://pypi.org/project/ibyrd/
   :alt: PyPI
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/ibyrd
   :target: https://pypi.org/project/ibyrd
   :alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/ibyrd
   :target: https://opensource.org/licenses/MIT
   :alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/ibyrd/latest.svg?label=Read%20the%20Docs
   :target: https://ibyrd.readthedocs.io/
   :alt: Read the documentation at https://ibyrd.readthedocs.io/
.. |Tests| image:: https://github.com/X-McKay/ibyrd/workflows/Tests/badge.svg
   :target: https://github.com/X-McKay/ibyrd/actions?workflow=Tests
   :alt: Tests
.. |Codecov| image:: https://codecov.io/gh/X-McKay/ibyrd/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/X-McKay/ibyrd
   :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
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Black


ibyrd is a Python package that provides tools for Birders and Researchers to:

* Explore and visualize information for Birders
* Easily interact with eBird APIs.


Project Maturity and readiness
------------------------------

iByrd is under active development; many key workflows and best practices are still being worked out.
More seamless interaction with eBird products is in development, as well as
general improvement the overall user experience.


A current major focus is visualization of user life-lists across various levels
of taxonomy and relevant categories.


Features
--------

* Retrieval of hotspots (eBird) via CLI and/or python
* Extracting the latest version of the eBird Taxonomy (species list for data entry and listing purposes across the world)



Requirements
------------

`ASDF`_ for managing multiple runtime verisions.

Installation
------------

You can install *ibyrd* via pip_ from PyPI_:

.. code:: console

   $ pip install ibyrd


Usage
-----

* IN PROGRESS

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 `MIT license`_,
*ibyrd* is free and open source software.


Issues
------

If you encounter any problems,
please `file an issue`_ along with a detailed description.


Credits
-------

* Cornell University

* Cornell Lab of Ornithology

* This project was originally based on `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.

* Credit to Tim Rodriguez for indirect influence of S&BP.

.. _@cjolowicz: https://github.com/cjolowicz
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _MIT license: https://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/
.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
.. _file an issue: https://github.com/X-McKay/ibyrd/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://ibyrd.readthedocs.io/en/latest/usage.html
.. _ASDF: http://asdf-vm.com/