OpenReader

An open-source e-reader for out-of-copyright books written in Python 3.

Installation

For the simplest method, just do this:

pip install flask-bootstrap # or use pip3 if Python 2 is your system default
flask init-db

For an isolated installation, the process is a bit more involved:

# First install the isolated package environment
# manager if it isn't already available
pip install virtualenv

# Next create a new virtual environment
virtualenv --python=python3 venv

# Activate the virtual environment in Bash.
# There are other scripts for other shells, like activate.fish and .ps1
source venv/bin/activate

# Once inside venv, pip will install packages isolated from your system
pip install flask-bootstrap

# Then setup your local state
flask init-db

# When you're done with flask, exit the virtual environment
deactivate

Usage

If you're using virtualenv, then first run source venv/bin/activate. Run deactivate or exit the shell to leave the virtual environment.

Commands

• flask run starts the server. Visit http://127.0.0.1:5000 in your browser.

• flask init-db creates or clears the database that stores user accounts.

• flask clear-cache deletes the cache folder. It's recreated automatically when needed.

Contributor Info

• Tabs, not spaces. That's what the tab key is for.

• Use quotes for strings, not apostrophes. The exception is in templates, where it messes up the syntax highlighting to use real quotes.

• Don't commit (even locally) if there are errors or warnings.

• Flask has a built-in development server that supports auto-reload on source change and shows an interactive debugger on errors. Run it with FLASK_ENV=development flask run.

• Flask also has a shell that's useful for debugging. Use flask shell, then access modules after importing them: import openreader.cache as cache. Once imported, you can test functions interactively: cache._contents()