calibreweb

v0.6.21

Web app for browsing, reading and downloading eBooks stored in a Calibre database. For more information about how to use this package see README

Latest version published 6 months ago

License: GPL-3.0

PyPI

GitHub

Package Health Score

66 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Active

Popularity

Small

GitHub Stars: 11.26K
Forks: 1.22K
Contributors: 210

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package calibreweb, we found that it has been starred 11,260 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 21, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 3
H
3
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 371
Open PR: 26
Last Release: 6 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of calibreweb based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that calibreweb demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 210
Funding: Yes

A good and healthy external contribution signal for calibreweb project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like calibreweb is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.10.*, ==3.11.*, ==3.6.*, ==3.7.*, ==3.8.*, ==3.9.*

Age: 3 years
Latest Release: 6 months ago
Dependencies: 20 Direct / 54 Total
Versions: 10
Maintainers: 1
Wheels: OS Independent

Readme

Calibre-Web

Calibre-Web is a web app that offers a clean and intuitive interface for browsing, reading, and downloading eBooks using a valid Calibre database.

Table of Contents (click to expand)

This software is a fork of library and licensed under the GPL v3 License.

Main screen

Features

Modern and responsive Bootstrap 3 HTML5 interface
Full graphical setup
Comprehensive user management with fine-grained per-user permissions
Admin interface
Multilingual user interface supporting 20+ languages (supported languages)
OPDS feed for eBook reader apps
Advanced search and filtering options
Custom book collection (shelves) creation
eBook metadata editing and deletion support
Metadata download from various sources (extensible via plugins)
eBook conversion through Calibre binaries
eBook download restriction to logged-in users
Public user registration support
Send eBooks to E-Readers with a single click
Sync Kobo devices with your Calibre library
In-browser eBook reading support for multiple formats
Upload new books in various formats, including audio formats
Calibre Custom Columns support
Content hiding based on categories and Custom Column content per user
Self-update capability
"Magic Link" login for easy access on eReaders
LDAP, Google/GitHub OAuth, and proxy authentication support

Installation

Installation via pip (recommended)

Create a virtual environment for Calibre-Web to avoid conflicts with existing Python dependencies
Install Calibre-Web via pip: pip install calibreweb (or pip3 depending on your OS/distro)
Install optional features via pip as needed, see this page for details
Start Calibre-Web by typing cps

Note: Raspberry Pi OS users may encounter issues during installation. If so, please update pip (./venv/bin/python3 -m pip install --upgrade pip) and/or install cargo (sudo apt install cargo) before retrying the installation.

Refer to the Wiki for additional installation examples: manual installation, Linux Mint, Cloud Provider.

Quick Start

Open your browser and navigate to http://localhost:8083 or http://localhost:8083/opds for the OPDS catalog
Log in with the default admin credentials
If you don't have a Calibre database, you can use this database (move it out of the Calibre-Web folder to prevent overwriting during updates)
Set Location of Calibre database to the path of the folder containing your Calibre library (metadata.db) and click "Save"
Optionally, use Google Drive to host your Calibre library by following the Google Drive integration guide
Configure your Calibre-Web instance via the admin page, referring to the Basic Configuration and UI Configuration guides

Default Admin Login:

Username: admin
Password: admin123

Requirements

Python 3.5+
Imagemagick for cover extraction from EPUBs (Windows users may need to install Ghostscript for PDF cover extraction)
Optional: Calibre desktop program for on-the-fly conversion and metadata editing (set "calibre's converter tool" path on the setup page)
Optional: Kepubify tool for Kobo device support (place the binary in /opt/kepubify on Linux or C:\Program Files\kepubify on Windows)

Docker Images

Pre-built Docker images are available in the following Docker Hub repositories (maintained by the LinuxServer team):

LinuxServer - x64, aarch64

Docker Hub
GitHub
GitHub - Optional Calibre layer

Include the environment variable DOCKER_MODS=linuxserver/mods:universal-calibre in your Docker run/compose file to add the Calibre ebook-convert binary (x64 only). Omit this variable for a lightweight image.

Both the Calibre-Web and Calibre-Mod images are automatically rebuilt on new releases and updates.
- Set "path to convertertool" to /usr/bin/ebook-convert
- Set "path to unrar" to /usr/bin/unrar

Contributor Recognition

We would like to thank all the contributors and maintainers of Calibre-Web for their valuable input and dedication to the project. Your contributions are greatly appreciated.

Contact

Join us on Discord

For more information, How To's, and FAQs, please visit the Wiki

Contributing to Calibre-Web

Check out our Contributing Guidelines

calibreweb dependencies

advocate apscheduler babel chardet flask flask-babel flask-limiter flask-login flask-principal flask-wtf iso-639 lxml pypdf pytz requests sqlalchemy tornado unidecode wand werkzeug

FAQs

What is calibreweb?

Web app for browsing, reading and downloading eBooks stored in a Calibre database. Visit Snyk Advisor to see a full health score report for calibreweb, including popularity, security, maintenance & community analysis.

Is calibreweb popular?

The python package calibreweb receives a total of 604 weekly downloads. As such, calibreweb popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is calibreweb well maintained?

We found indications that calibreweb is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is calibreweb safe to use?

While scanning the latest version of calibreweb, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 17 April-2024, at 17:24 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP