Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monospaced/paperback
Read e-books on the web.
https://github.com/monospaced/paperback
Last synced: about 2 months ago
JSON representation
Read e-books on the web.
- Host: GitHub
- URL: https://github.com/monospaced/paperback
- Owner: monospaced
- License: other
- Created: 2014-05-16T21:37:46.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-05T19:37:07.000Z (over 8 years ago)
- Last Synced: 2024-04-14T12:32:23.296Z (9 months ago)
- Language: Python
- Homepage: http://monospaced.github.io/paperback
- Size: 2.45 MB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Paperback
Paperback is a web based e-book reading system, in 2 parts:
1. [Ebla](#ebla), an e-book reading web app.
2. [Melk](#melk), utility to format e-book files for reading in Ebla.
Currently the only e-book file format supported by Melk/Ebla is [EPUB 2](http://idpf.org/epub/201).
[See it in action](http://monospaced.github.io/paperback).
## Contributing
Ebla and Melk are proof of concepts, further development is required!
This project is open source and MIT licenced, so please do get involved :)
Plan is to use [GitHub issues](https://github.com/monospaced/paperback/issues) to guide the development process.
## Ebla
Ebla is an e-book reading web app.
Initally designed and developed by monospaced, thegingerbloke and carlotartaglia, Ebla has been open sourced as part of this project.
### Usage
Ebla needs to be running on the `http://` protocol, so once you have downloaded or cloned the repository, you will need to run it on a web server.
If you’re on OS X or Linux, you can simply:
1. Navigate a console to the `paperback/` directory
2. Enter `python -m SimpleHTTPServer 8888`
3. Navigate a browser to `http://localhost:8888/`
Then open the included sample book and start reading!
### Build Requirements
Ebla uses [Sass](http://sass-lang.com/) and [Grunt](http://gruntjs.com/) to preprocess and build its CSS and JavaScript files.
It comes pre-built, so you can start using it straight away. To build a new version, you will need to have Ruby, Sass, Node and NPM installed.
If you’re on OS X or Linux you probably have Ruby installed already; test with `ruby -v` in your terminal. When you’ve confirmed you have Ruby installed, run `gem install sass` to install Sass.
You can test for Node and NPM with `node -v` and `npm -v` in your terminal. If you don't have them, head over to [nodejs.org](http://nodejs.org/).
To build Ebla (with the required dependencies); from inside the `ebla/` directory run `grunt` to build once, or `grunt watch` to build automatically whenever a Sass or JavaScript file is updated.
### AngularJS
Ebla is using [AngularJS](https://angularjs.org/) to read the JSON files required to display each book. However, there is no intrinsic dependancy on AngularJS in Ebla’s current design—these aspects of the app could happily be rewritten with a server-side language, with the added benefit of removing the JavaScript dependency altogether (as the reader itself includes a no-js fallback).
## Melk
Melk is a Python command line utility that formats and stores EPUB files for reading in Ebla.
### Usage
````
python melk /path/to/file.epub
````
````
python melk /path/to/epubs
````
### Options
````
--version show program's version number and exit
-h, --help show this help message and exit
-b BOOKS, --books=BOOKS specify path to books relative to script directory defaults to ../books/
````
### Requirements
* Python 2.6+ (not tested on Python 3)
### How it works
* Converts the XML metadata and navigation components of the EPUB file to JSON.
* Standarises the markup components of the epub file as XHTML, standardises their `` elements, adds the Ebla stylesheet, and passes the plain text through [typogrify](https://github.com/mintchaos/typogrify) filters to yield typographically-improved HTML.
* Creates a folder for each converted book in a specified directory and catalogs the directory’s contents as JSON.
## Why the names?
The ancient city of Ebla is famous for its archive of roughly 20,000 cuneiform tablets, dating from around 2350 BC and written in both the Sumerian and Eblaite languages. The Ebla archive is considered (by some) to be the world’s oldest library.
Founded in the 12th century, the monastic library of Melk Abbey became renowned for its extensive manuscript collection. The monastery’s scriptorium was also a major site for the production of manuscripts.
The first Penguin paperbacks represented ease, accessibility, and democratisation of good literature—a paperback revolution.
## Sample books
[Enjoy some Paperbacks!](http://pageskip.monospaced.com/)