Django web application to display, annotate, and export digitized books in a Fedora Commons repository
JavaScript Python CSS HTML XSLT
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
deploy
docs
readux
requirements
sitemedia
templates
.codeclimate.yml
.gitignore
CHANGELOG.rst
DEPLOYNOTES.rst fix Daphne issue by locking versions Jan 27, 2017
LICENSE
README.rst Add landscape.io code health badge Jul 29, 2016
fabfile.py
manage.py
requirements.txt

README.rst

Readux

documentation
Documentation Status
code
Code Climate Requirements Status Code Health

Readux is a repository-based Django web application for access to digitized books. Readux runs on Fedora Commons 3.8 and Django 1.8. Readux provides search and browse access to all digitized books, citations that can be harvested with Zotero, the ability to send text to Voyant for analysis. For volumes with pages loaded, OCR text is provided as an invisible overlay on page images for selection and search. Logged in users can annotate text and image selections of page images, and can export an annotated volume as TEI or a standalone Jekyll website.

Documentation available at readux.readthedocs.org.

License

This software is distributed under the Apache 2.0 License.

Dependencies

Services

  • SQL database for administration, user accounts, collection banner images, and annotation storage
  • Fedora repository for access to digitized book content
  • Apache Solr for browse by collection, search across all volumes, and search within a single volume
  • IIIF image server for page image content; e.g. Loris

Software Dependencies

Components

readux.collection
Models and views for access to collections, which are used to group digitized book content
readux.books
Models and views for access to digizited book content; includes management commands for loading book covers and page content and generating page-level TEI facsimile
readux.annotations
Django db models and views to provide an annotator-store backend; implements the Annotator Core Storage api.
readux.pages
Functionality for site content such as an about page, annotation and export documentation, credits. Content management based on FeinCMS.