100% coverage of checks schemas

README.rst

@@ -0,0 +1,103 @@
+Py Healthchecks.Io
+==================
+
+|PyPI| |Status| |Python Version| |License|
+
+|Read the Docs| |Tests| |Codecov|
+
+|pre-commit| |Black|
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/py-healthchecks.io.svg
+   :target: https://pypi.org/project/py-healthchecks.io/
+   :alt: PyPI
+.. |Status| image:: https://img.shields.io/pypi/status/py-healthchecks.io.svg
+   :target: https://pypi.org/project/py-healthchecks.io/
+   :alt: Status
+.. |Python Version| image:: https://img.shields.io/pypi/pyversions/py-healthchecks.io
+   :target: https://pypi.org/project/py-healthchecks.io
+   :alt: Python Version
+.. |License| image:: https://img.shields.io/pypi/l/py-healthchecks.io
+   :target: https://opensource.org/licenses/MIT
+   :alt: License
+.. |Read the Docs| image:: https://img.shields.io/readthedocs/py-healthchecks.io/latest.svg?label=Read%20the%20Docs
+   :target: https://py-healthchecks.io.readthedocs.io/
+   :alt: Read the documentation at https://py-healthchecks.io.readthedocs.io/
+.. |Tests| image:: https://github.com/andrewthetechie/py-healthchecks.io/workflows/Tests/badge.svg
+   :target: https://github.com/andrewthetechie/py-healthchecks.io/actions?workflow=Tests
+   :alt: Tests
+.. |Codecov| image:: https://codecov.io/gh/andrewthetechie/py-healthchecks.io/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/andrewthetechie/py-healthchecks.io
+   :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
+
+A python client for healthchecks.io. Supports the management api and ping api
+
+Features
+--------
+
+* TODO
+
+
+Requirements
+------------
+
+* TODO
+
+
+Installation
+------------
+
+You can install *Py Healthchecks.Io* via pip_ from PyPI_:
+
+.. code:: console
+
+   $ pip install py-healthchecks.io
+
+
+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 `MIT license`_,
+*Py Healthchecks.Io* 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 `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.
+
+.. _@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/andrewthetechie/py-healthchecks.io/issues
+.. _pip: https://pip.pypa.io/
+.. github-only
+.. _Contributor Guide: CONTRIBUTING.rst
+.. _Usage: https://py-healthchecks.io.readthedocs.io/en/latest/usage.html