Skip to content
Travis Watt edited this page Jun 10, 2014 · 4 revisions

ReadingTool Wiki

What is it?

It is an offline tool to assist with reading in a foreign language. You add your own texts and then as you read you can enter definitions for words or phrases that you do not know. These words and phrases are then highlighted on all further texts that you add. (screenshots here)

In general it should work for any language that has spaces between the words (eg: German, French, Turkish). Languages which don't delineate words with spaces (eg: Japanese, Chinese) must be segmented beforehand. Currently there is builtin support for Japanese via Mecab. You will need an API key from http://api.readingtool.net in order to use this, or alternatively you can install Mecab on your own computer.

##Useful Features

  • Supports both single language and parallel texts.
  • Supports both single language and parallel subtitled videos (SRT format).
  • PDF creation
  • Simple JSON API for interacting with your data.
  • Plugins (see http://api.readingtool.net/plugins for examples)
  • A storage API to store additional metadata with your terms (or anything else). For example gender or case.

##Requirements

Currently there is no packaged release, so you will need a development setup. Currently that is:

  • Python 3.3
  • PyQt4
  • PyQt4 QSci

In addition the following Python packages are required:

  • requests
  • CherryPy
  • routes
  • lxml

##Installation

At the moment you will need to either clone the source or download the ZIP file. You will also need the software and packages as listed in the requirements.

##Usage/Screenshots

Available here

##License

This software is licensed under the AGPL. You can find more details on the official site.

Clone this wiki locally