Metadata-Version: 2.1
Name: calibreweb
Version: 0.6.12
Summary: Web app for browsing, reading and downloading eBooks stored in a Calibre database.
Home-page: https://github.com/janeczku/calibre-web
Author: @OzzieIsaacs
Author-email: Ozzie.Fernandez.Isaacs@googlemail.com
Maintainer: @OzzieIsaacs
License: GPLv3+
Project-URL: Bug Tracker, https://github.com/janeczku/calibre-web/issues
Project-URL: Release Management, https://github.com/janeczku/calibre-web/releases
Project-URL: Documentation, https://github.com/janeczku/calibre-web/wiki
Project-URL: Source Code, https://github.com/janeczku/calibre-web
Keywords: calibre,calibre-web,library
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: Babel (<3.0,>=1.3)
Requires-Dist: Flask-Babel (<2.1.0,>=0.11.1)
Requires-Dist: Flask-Login (<0.5.1,>=0.3.2)
Requires-Dist: Flask-Principal (<0.5.1,>=0.3.2)
Requires-Dist: backports-abc (>=0.4)
Requires-Dist: Flask (<2.1.0,>=1.0.2)
Requires-Dist: iso-639 (<0.5.0,>=0.4.5)
Requires-Dist: PyPDF3 (<1.0.4,>=1.0.0)
Requires-Dist: pytz (>=2016.10)
Requires-Dist: requests (<2.25.0,>=2.11.1)
Requires-Dist: SQLAlchemy (<1.5.0,>=1.3.0)
Requires-Dist: tornado (<6.2,>=4.1)
Requires-Dist: Wand (<0.7.0,>=0.4.4)
Requires-Dist: unidecode (<1.3.0,>=0.04.19)
Provides-Extra: comics
Requires-Dist: natsort (<7.2.0,>=2.2.0) ; extra == 'comics'
Requires-Dist: comicapi (<2.3.0,>=2.2.0) ; extra == 'comics'
Provides-Extra: gdrive
Requires-Dist: google-api-python-client (<2.1.0,>=1.7.11) ; extra == 'gdrive'
Requires-Dist: gevent (<21.2.0,>20.6.0) ; extra == 'gdrive'
Requires-Dist: greenlet (<1.2.0,>=0.4.17) ; extra == 'gdrive'
Requires-Dist: httplib2 (<0.20.0,>=0.9.2) ; extra == 'gdrive'
Requires-Dist: oauth2client (<4.1.4,>=4.0.0) ; extra == 'gdrive'
Requires-Dist: uritemplate (<3.1.0,>=3.0.0) ; extra == 'gdrive'
Requires-Dist: pyasn1-modules (<0.3.0,>=0.0.8) ; extra == 'gdrive'
Requires-Dist: pyasn1 (<0.5.0,>=0.1.9) ; extra == 'gdrive'
Requires-Dist: PyDrive2 (<1.9.0,>=1.3.1) ; extra == 'gdrive'
Requires-Dist: PyYAML (>=3.12) ; extra == 'gdrive'
Requires-Dist: rsa (<4.8.0,>=3.4.2) ; extra == 'gdrive'
Requires-Dist: six (<1.17.0,>=1.10.0) ; extra == 'gdrive'
Provides-Extra: gmail
Requires-Dist: google-auth-oauthlib (<0.5.0,>=0.4.3) ; extra == 'gmail'
Requires-Dist: google-api-python-client (<2.1.0,>=1.7.11) ; extra == 'gmail'
Provides-Extra: goodreads
Requires-Dist: goodreads (<0.4.0,>=0.3.2) ; extra == 'goodreads'
Requires-Dist: python-Levenshtein (<0.13.0,>=0.12.0) ; extra == 'goodreads'
Provides-Extra: kobo
Requires-Dist: jsonschema (<3.3.0,>=3.2.0) ; extra == 'kobo'
Provides-Extra: ldap
Requires-Dist: python-ldap (<3.4.0,>=3.0.0) ; extra == 'ldap'
Requires-Dist: Flask-SimpleLDAP (<1.5.0,>=1.4.0) ; extra == 'ldap'
Provides-Extra: metadata
Requires-Dist: lxml (<4.7.0,>=3.8.0) ; extra == 'metadata'
Requires-Dist: rarfile (>=2.7) ; extra == 'metadata'
Provides-Extra: oauth
Requires-Dist: Flask-Dance (<5.1.0,>=2.0.0) ; extra == 'oauth'
Requires-Dist: SQLAlchemy-Utils (<0.38.0,>=0.33.5) ; extra == 'oauth'

# About

Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing [Calibre](https://calibre-ebook.com) database.

![GitHub License](https://img.shields.io/github/license/janeczku/calibre-web) ![GitHub Downloads](https://img.shields.io/github/downloads/janeczku/calibre-web/total) ![GitHub commit activity](https://img.shields.io/github/commit-activity/w/janeczku/calibre-web?logo=github) [![Discord](https://img.shields.io/discord/838810113564344381?label=Discord&logo=discord)](https://discord.gg/h2VsJ2NEfB) 

*This software is a fork of [library](https://github.com/mutschler/calibreserver) and licensed under the GPL v3 License.*

![Main screen](https://github.com/janeczku/calibre-web/wiki/images/main_screen.png)

## Features

- Bootstrap 3 HTML5 interface
- full graphical setup
- User management with fine-grained per-user permissions
- Admin interface
- User Interface in brazilian, czech, dutch, english, finnish, french, german, greek, hungarian, italian, japanese, khmer, polish, russian, simplified chinese, spanish, swedish, turkish, ukrainian
- OPDS feed for eBook reader apps 
- Filter and search by titles, authors, tags, series and language
- Create a custom book collection (shelves)
- Support for editing eBook metadata and deleting eBooks from Calibre library
- Support for converting eBooks through Calibre binaries
- Restrict eBook download to logged-in users
- Support for public user registration
- Send eBooks to Kindle devices with the click of a button
- Sync your Kobo devices through Calibre-Web with your Calibre library
- Support for reading eBooks directly in the browser (.txt, .epub, .pdf, .cbr, .cbt, .cbz, .djvu)
- Upload new books in many formats, including audio formats (.mp3, .m4a, .m4b)
- Support for Calibre Custom Columns
- Ability to hide content based on categories and Custom Column content per user
- Self-update capability
- "Magic Link" login to make it easy to log on eReaders
- Login via LDAP, google/github oauth and via proxy authentication

## Quick start

1. Install dependencies by running `pip3 install --target vendor -r requirements.txt` (python3.x). Alternativly set up a python virtual environment.
2. Execute the command: `python3 cps.py` (or `nohup python3 cps.py` - recommended if you want to exit the terminal window)
3. Point your browser to `http://localhost:8083` or `http://localhost:8083/opds` for the OPDS catalog
4. Set `Location of Calibre database` to the path of the folder where your Calibre library (metadata.db) lives, push "submit" button\
   Optionally a Google Drive can be used to host the calibre library [-> Using Google Drive integration](https://github.com/janeczku/calibre-web/wiki/Configuration#using-google-drive-integration)
5. Go to Login page

**Default admin login:**\
*Username:* admin\
*Password:* admin123

**Issues with Ubuntu:**
Please note that running the above install command can fail on some versions of Ubuntu, saying `"can't combine user with prefix"`. This is a [known bug](https://github.com/pypa/pip/issues/3826) and can be remedied by using the command `pip install --system --target vendor -r requirements.txt` instead.

## Requirements

python 3.x+

Optionally, to enable on-the-fly conversion from one ebook format to another when using the send-to-kindle feature, or during editing of ebooks metadata:

[Download and install](https://calibre-ebook.com/download) the Calibre desktop program for your platform and enter the folder including program name (normally /opt/calibre/ebook-convert, or C:\Program Files\calibre\ebook-convert.exe) in the field "calibre's converter tool" on the setup page.

[Download](https://github.com/pgaskin/kepubify/releases/latest) Kepubify tool for your platform and place the binary starting with `kepubify` in Linux: `\opt\kepubify` Windows: `C:\Program Files\kepubify`.

## Docker Images

Pre-built Docker images are available in these Docker Hub repositories:

#### **Technosoft2000 - x64**
+ Docker Hub - [https://hub.docker.com/r/technosoft2000/calibre-web](https://hub.docker.com/r/technosoft2000/calibre-web)
+ Github - [https://github.com/Technosoft2000/docker-calibre-web](https://github.com/Technosoft2000/docker-calibre-web) 

    Includes the Calibre `ebook-convert` binary.
    + The "path to convertertool" should be set to `/opt/calibre/ebook-convert`

#### **LinuxServer - x64, armhf, aarch64**
+ Docker Hub - [https://hub.docker.com/r/linuxserver/calibre-web](https://hub.docker.com/r/linuxserver/calibre-web)
+ Github - [https://github.com/linuxserver/docker-calibre-web](https://github.com/linuxserver/docker-calibre-web)
+ Github - (Optional Calibre layer) - [https://github.com/linuxserver/docker-calibre-web/tree/calibre](https://github.com/linuxserver/docker-calibre-web/tree/calibre) 

   This image has the option to pull in an extra docker manifest layer to include the Calibre `ebook-convert` binary.  Just include the environmental variable `DOCKER_MODS=linuxserver/calibre-web:calibre` in your docker run/docker compose file. **(x64 only)**

   If you do not need this functionality then this can be omitted, keeping the image as lightweight as possible.

   Both the Calibre-Web and Calibre-Mod images are rebuilt automatically on new releases of Calibre-Web and Calibre respectively, and on updates to any included base image packages on a weekly basis if required.
   + The "path to convertertool" should be set to `/usr/bin/ebook-convert`
   + The "path to unrar" should be set to `/usr/bin/unrar`

# Contact

Just reach us out on [Discord](https://discord.gg/h2VsJ2NEfB)

For further information, How To's and FAQ please check the [Wiki](https://github.com/janeczku/calibre-web/wiki)

# Contributing to Calibre-Web

Please have a look at our [Contributing Guidelines](https://github.com/janeczku/calibre-web/blob/master/CONTRIBUTING.md) 


