Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
The Internet, peer reviewed.
Python CoffeeScript JavaScript

This branch is 6052 commits behind hypothesis:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
h
.gitignore
.gitmodules
CHANGES
LICENSE
MANIFEST.in
NOTICE
README.rst
development.ini
requirements.txt
run.py
setup.py

README.rst

Hypothes.is

About

Hypothes.is brings community peer review to The Internet. It is a web site and a browser application which enable rich annotation of web content. The web site acts as both a community and authentication end point as well as a deployment host for the browser application.

The browser application is based substantially on work by the Open Knowledge Foundation on the Annotator Project.

Please join us in #hypothes.is on freenode.

Installation

Hypothes.is currently requires several tools to build and run from scratch. In the future, releases will include built versions of static assets for integrators wanting to produce custom embeddings of the project on their own sites and the project welcomes packaging efforts to make including the Hypothes.is service in any framework easy.

The project code itself is a pyramid application which can be integrated into any WSGI_ compatible framework and run on any WSGI web server (such as gunicorn or uWSGI). Until the project is ready for an alpha release, it may not be installable from the Python Package Index. Instead, the application should be built in a virtual environment which can be set up as follows:

$ virtualenv --no-site-packages .
$ source bin/activate
$ pip install -r requirements.txt

If there is a failure installing PyYAML, install the libyaml development files.

For building the static assets, requirements currently include CoffeeScript (needed by the Annotator), Sass, Compass and Handlebars. These dependencies should be easily installable via common package management utilities.

To run an annotation storage backend elasticsearch is required.

Please see the platform-specific INSTALL files for additional assistance.

Development

See #hypothes.is.

The Annotator project is included as a git sub-module to encourage upstream contribution and flexible collaboration. To make sure you have the appropriate version of the sub-module source, run the following commands:

$ git submodule init
$ git submodule update

The annotator directory will be checked out into the hypothesis package directory.

License

Hypothes.is 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.

Something went wrong with that request. Please try again.