fledge 0.1.0a3
Fledge
License: MIT
Requires Python: >=3.9,<4

|PyPI| |Status| |Python Version| |License|

|Read the Docs| |Tests| |Codecov|

|pre-commit| |Black|

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


.. image:: https://github.com/benjamindkilleen/fledge/raw/main/docs/_static/fledge_logo_text_small.png
   :alt: Fledge logo.
   :align: center


Description
-----------

Fledge is an in-development project. It has a well-defined scope and initial structure but is not
ready for users. As such, the statements made here are more aspirational than actual.

Features
--------

* TODO


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

* TODO


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

You can install *Fledge* via pip_ from PyPI_:

.. code:: console

   $ pip install fledge


Usage
-----

Please see the `Command-line Reference <Usage_>`_ for details.


Contributing
------------

Contributions are very welcome.
To learn more, see `Contributing`_.


License
-------

Distributed under the terms of the `MIT license`_,
*Fledge* is free and open source software.


Issues
------

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


Credits
-------

Idea and initial development by `Benjamin D. Killeen`_. Logo by `Sarah Larson`_.
Package layout is based on the `Hypermodern Python Cookiecutter`_ template.
Logo font (Ainslee Sans) by `Jeremy Dooley`_.

.. _@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/benjamindkilleen/fledge/issues
.. _pip: https://pip.pypa.io/
.. _Benjamin D. Killeen: https://benjamindkilleen.com
.. _Sarah Larson: https://sarahmarielarson.com
.. _Jeremy Dooley: https://fonts.adobe.com/designers/jeremy-dooley
.. github-only
.. _Contributing: CONTRIBUTING.rst
.. _Usage: https://fledge.readthedocs.io/en/latest/usage.html