ackermann/hypothesis repository overview

⁠Hypothesis

.. image:: https://travis-ci.org/hypothesis/h.svg?branch=master⁠ :target: https://travis-ci.org/hypothesis/h⁠ :alt: Build Status .. image:: https://codecov.io/github/hypothesis/h/coverage.svg?branch=master⁠ :target: https://codecov.io/github/hypothesis/h?branch=master⁠ :alt: Code Coverage .. image:: https://landscape.io/github/hypothesis/h/master/landscape.svg?style=flat⁠ :target: https://landscape.io/github/hypothesis/h/master⁠ :alt: Code Health .. image:: https://img.shields.io/badge/IRC-%23hypothes.is-blue.svg⁠ :target: #hypothes.is_ :alt: #hypothes.is IRC channel .. image:: https://img.shields.io/badge/license-BSD-blue.svg⁠ :target: https://github.com/hypothesis/h/blob/master/LICENSE⁠ :alt: License badge .. image:: https://img.shields.io/badge/python-2.7-blue.svg⁠ :alt: Python version badge

⁠About

Hypothesis is a tool for annotating the web.

• A service for storing community annotations

• An account system for user registration

• Authorization for client applications

• A browser-based annotator client featuring:

  • Chrome and Firefox browser extensions
  • A bookmarklet
  • A publisher embed code

⁠Installation and deployment

See the Installation guide <https://h.readthedocs.org/en/latest/INSTALL.html>_ for instructions on deploying h in a production environment.

⁠Development

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

⁠Community

Join us in #hypothes.is_ on freenode_ for discussion.

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. Issues tagged with the label 'New Contributor Friendly' are ideal for those just getting started.

.. _#hypothes.is: https://www.irccloud.com/invite?channel=%23hypothes.is&hostname=irc.freenode.net&port=6667&ssl=1⁠ .. _freenode: http://freenode.net/⁠ .. _subscribe: mailto:[email protected]⁠ .. _development mailing list: https://groups.google.com/a/list.hypothes.is/forum/#!forum/dev⁠ .. _Contributor's guide: https://h.readthedocs.org/en/latest/hacking/⁠ .. _New Contributor Friendly: https://github.com/hypothesis/h/issues?q=is%3Aopen+is%3Aissue+label%3A%22New+Contributor+Friendly%22⁠

⁠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⁠