h

.. image:: https://github.com/hypothesis/h/actions/workflows/ci.yml/badge.svg?branch=main :target: https://github.com/hypothesis/h/actions?query=branch%3Amain :alt: Continuous integration .. image:: https://img.shields.io/badge/license-BSD-blue.svg :target: https://github.com/hypothesis/h/blob/main/LICENSE :alt: BSD licensed .. image:: https://img.shields.io/badge/python-3.6-blue.svg :target: https://www.python.org/ :alt: Python 3.6 .. image:: https://readthedocs.org/projects/h/badge/?version=latest :target: https://h.readthedocs.io/en/latest/?badge=latest :alt: Docs .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black :alt: Code style: Black

h is the web app that serves most of the https://hypothes.is/ website, including the web annotations API at https://hypothes.is/api/. The Hypothesis client <https://github.com/hypothesis/client>_ is a browser-based annotator that is a client for h's API.

Development

See the Contributor's guide_ for instructions on setting up a development environment and contributing to h.

Community

Join us on Slack (request an invite_ or log in once you've created an account_).

If you'd like to contribute to the project, you should also subscribe_ to the development mailing list_ and read our Contributor's guide_. Then consider getting started on one of the issues that are ready for work.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

.. _request an invite: https://slack.hypothes.is .. _log in once you've created an account: https://hypothesis-open.slack.com/ .. _subscribe: mailto:[email protected] .. _development mailing list: https://groups.google.com/a/list.hypothes.is/forum/#!forum/dev .. _Contributor's guide: https://h.readthedocs.io/en/latest/developing/

License

Hypothesis is released under the 2-Clause BSD License, sometimes referred to as the "Simplified BSD License" or the "FreeBSD License". Some third-party components are included. They are subject to their own licenses. All of the license information can be found in the included <LICENSE> file.

.. _2-Clause BSD License: http://www.opensource.org/licenses/BSD-2-Clause