Skip to content
This repository

The Internet, peer reviewed.

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 docs Update api.rst January 22, 2014
Octocat-spinner-32 h Hide the timestamp when editing April 20, 2014
Octocat-spinner-32 pdf.js @ df7232e Add pdf.js as a submodule April 01, 2014
Octocat-spinner-32 tests Add source encoding comments to all .py tests April 16, 2014
Octocat-spinner-32 .gitattributes add versioneer October 09, 2012
Octocat-spinner-32 .gitignore remove webassets cache from gitignore April 12, 2013
Octocat-spinner-32 .gitmodules Add pdf.js as a submodule April 01, 2014
Octocat-spinner-32 .travis.yml Enable wheels in pip usage April 15, 2014
Octocat-spinner-32 AUTHORS whitespace :) October 22, 2013
Octocat-spinner-32 CHANGES releasing v0.0.6 January 08, 2013
Octocat-spinner-32 CONTRIBUTING.rst Naming convention change: data-ng => ng April 02, 2013
Octocat-spinner-32 INSTALL.ArchLinux.rst Update INSTALL doc dependency information March 10, 2014
Octocat-spinner-32 INSTALL.Debian.rst Update INSTALL doc dependency information March 10, 2014
Octocat-spinner-32 INSTALL.Fedora.rst Update INSTALL doc dependency information March 10, 2014
Octocat-spinner-32 INSTALL.OSX.rst Note version issues with homebrew elastic search, mark elasticsearch … April 05, 2014
Octocat-spinner-32 INSTALL.Ubuntu.rst Update INSTALL doc dependency information March 10, 2014
Octocat-spinner-32 INSTALL.Vagrant.rst Consistent style of code blocks in INSTALL docs October 08, 2013
Octocat-spinner-32 INSTALL.rst Change ES version in INSTALL.rst April 05, 2014
Octocat-spinner-32 LICENSE Happy new year February 05, 2014
Octocat-spinner-32 MANIFEST.in Update versioneer April 16, 2014
Octocat-spinner-32 Makefile Add back the pidfile option to the test run April 15, 2014
Octocat-spinner-32 NOTICE add sockjs license info June 23, 2013
Octocat-spinner-32 Procfile Add production.ini and strip down development.ini April 02, 2014
Octocat-spinner-32 README.rst Add more notes about extension building April 04, 2014
Octocat-spinner-32 Vagrantfile Vagrant --no-ri and --no-rdoc compass and sass April 05, 2014
Octocat-spinner-32 alembic.ini fix alembic logging April 03, 2014
Octocat-spinner-32 assets.yaml Follow Annotator changes April 14, 2014
Octocat-spinner-32 bootstrap Enable wheels in pip usage April 15, 2014
Octocat-spinner-32 development.ini More test.ini and development.ini tidying April 14, 2014
Octocat-spinner-32 gunicorn.conf.py Clean imports, lint aggressively, drop simplejson April 18, 2014
Octocat-spinner-32 host.pem good news everyone! paste supports https easily April 24, 2013
Octocat-spinner-32 production.ini Remove Beaker sessions and h.session April 19, 2014
Octocat-spinner-32 requirements.txt Clean imports, lint aggressively, drop simplejson April 18, 2014
Octocat-spinner-32 run Improve pserve wrapper, `hypothesis serve` April 15, 2014
Octocat-spinner-32 setup.cfg setup.cfg: zip_ok = false August 17, 2012
Octocat-spinner-32 setup.py Remove Beaker sessions and h.session April 19, 2014
Octocat-spinner-32 test.ini Add missing directive in test.ini April 15, 2014
Octocat-spinner-32 versioneer.py Update versioneer April 16, 2014
README.rst

Hypothes.is

About

Hypothes.is brings community peer review to The Internet. It is a web application which enables rich annotation of web content. The project acts as a community aggregator for annotations and identity provider [*] for annotators. It also serves embed code for an annotation agent designed with modern web browsers in mind.

Installation

See INSTALL.rst for installation instructions. Platform specific instructions can be found in the install documents as well.

Running

Installation has, hopefully, gone smoothly. If you ran into any problems, be sure to seek help on IRC or the mailing list. To run the server, simply use the run command:

$ ./run

This command will start the server on port 5000 (https://0.0.0.0:5000), reload the application whenever changes are made to the source code, and restart it should it crash for some reason.

Note

Using the bookmarklet or otherwise embedding the application may not be possible on sites accessed via HTTPS due to browser policy restricting the inclusion of non-SSL content. If you wish to test the development server with these sites uncomment the line beginning with "certfile" in the development server configuration file, "development.ini". This will cause the server to use a self-signed certificate included for testing.

Development

The project builds heavily on components developed for the Annotator Project and is structured to encourage upstream contribution where possible. However, work is required to make Annotator more extensible in order to facilitate contribution.

Additionally, work is underway to support the data model described by the Open Annotation Core specification document.

See the project wiki for the roadmap and additional information and join us in #hypothes.is on freenode for discussion.

Those wishing to contribute to the project should also subscribe to the development mailing list and read about contributing. Then consider getting started on one of the issues that are ready for work by clicking on the badge below. Issues tagged with the label 'cake' are ideal for new contributors.

Stories in Ready Build Status

Chrome Extension

To build the Chrome extension, follow the installation instructions and then check out and build the pdf.js submodule:

$ git submodule init
$ git submodule update
$ cd pdf.js
$ node make generic
$ node make chromium

Then, run the following command at the prompt to build the extension:

$ ./bin/hypothesis extension development.ini http://localhost:5000/app

If you are managing your virtual environment yourself, the script may not be located in the bin directory, but should be available in your path when the virtual environment is activated.

The third argument is the base URL for the application. An optional, fourth argument may be passed to override the URL prefix used for static assets.

At this point, a working extension should exist in ./build/chrome but with the development configuration the static assets are still loaded from the server. Start the application and ensure that the assets are built by visiting the /app route or by running ./bin/hypothesis assets.

Deployment

Deployment is mostly left as an exercise to the reader until we document this better. Using `Docker`_ it is easy to configure the ElasticSearch host and the mail relay address. Simply create links with the names elasticsearch and mail respectively.

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.

[*] Community and identity features are not finished. Get involved and help!
Something went wrong with that request. Please try again.