calibreweb

v0.6.24

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 1 month ago

License: GPL-3.0

PyPI

GitHub

Package Health Score

75 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Active

Popularity

Small

GitHub Stars: 13.35K
Forks: 1.41K
Contributors: 230

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Nov 16, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 3
H
1
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

Healthy

Commit Frequency

Open Issues: 312
Open PR: 21
Last Release: 1 month ago
Last Commit: 4 days 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 Healthy.

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

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 230
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.6

Age: 4 years
Latest Release: 1 month ago
Dependencies: 0 Direct
Versions: 13
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: It’s essential to isolate your Calibre-Web installation to avoid dependency conflicts. You can create a virtual environment by running:
```
python3 -m venv calibre-web-env
```
Activate the virtual environment:
```
source calibre-web-env/bin/activate
```
Install Calibre-Web: Use pip to install the application:
```
pip install calibreweb
```
Install optional features: For additional functionality, you may need to install optional features. Refer to this page for details on what can be installed.
Start Calibre-Web: After installation, you can start the application with:
```
cps
```

Note: Users of Raspberry Pi OS may encounter installation issues. If you do, try upgrading pip and/or installing cargo as follows:

./venv/bin/python3 -m pip install --upgrade pip
sudo apt install cargo

Important Links

For additional installation examples, check the following:

Quick Start

Access Calibre-Web: Open your browser and navigate to:
```
http://localhost:8083
```
or for the OPDS catalog:
```
http://localhost:8083/opds
```
Log in: Use the default admin credentials:
- Username: admin
- Password: admin123
Database Setup: If you do not have a Calibre database, download a sample from:
```
https://github.com/janeczku/calibre-web/raw/master/library/metadata.db
```
Move it out of the Calibre-Web folder to avoid overwriting during updates.
Configure Calibre Database: In the admin interface, set the Location of Calibre database to the path of the folder containing your Calibre library (where metadata.db is located) and click "Save".
Google Drive Integration: For hosting your Calibre library on Google Drive, refer to the Google Drive integration guide.
Admin Configuration: Configure your instance via the admin page, referring to the Basic Configuration and UI Configuration guides.

Requirements

Python Version: Ensure you have Python 3.7 or newer.
Imagemagick: Required for cover extraction from EPUBs. Windows users may also need to install Ghostscript for PDF cover extraction.
Windows Users: Install libmagic for 32bit python or libmagic for 64bit python, depending on your Python version. Make sure these files are included in your path.
Optional Tools:
- Calibre desktop program: Recommended for on-the-fly conversion and metadata editing. Set the path to Calibre’s converter tool on the setup page.
- Kepubify tool: Needed for Kobo device support. Download the tool and place the binary in /opt/kepubify on Linux or C:\Program Files\kepubify on Windows.

Docker Images

Pre-built Docker images are available:

LinuxServer - x64, aarch64

Docker Hub: linuxserver/calibre-web
GitHub: linuxserver/docker-calibre-web
Optional Calibre layer: linuxserver/docker-mods

To include the Calibre ebook-convert binary (x64 only), add the environment variable:

DOCKER_MODS=linuxserver/mods:universal-calibre

in your Docker run/compose file. Omit this variable for a lightweight image.

Paths Configuration:
- Set Path to Calibre Binaries to /usr/bin.
- Set Path to Unrar to /usr/bin/unrar.

Troubleshooting

Common Issues:
- If you experience issues starting the application, check the log files located in the logs directory for error messages.
- If eBooks fail to load, verify that the Location of Calibre database is correctly set and that the database file is accessible.
Configuration Errors: Ensure that your Calibre database is compatible and properly formatted. Refer to the Calibre documentation for guidance on maintaining the database.
Performance Problems:
- If the application is slow, consider increasing the allocated resources (CPU/RAM) to your server or optimizing the Calibre database by removing duplicates and unnecessary entries.
- Regularly clear the cache in your web browser to improve loading times.
User Management Issues: If users are unable to log in or register, check the user permission settings in the admin interface. Ensure that registration is enabled and that users are being assigned appropriate roles.
Support Resources: For additional help, consider visiting the FAQ section of the wiki or posting your questions in the Discord community.

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

To contribute, please check our Contributing Guidelines. We welcome issues, feature requests, and pull requests from the community.

Reporting Bugs

If you encounter bugs or issues, please report them in the issues section of the repository. Be sure to include detailed information about your setup and the problem encountered.

Feature Requests

We welcome suggestions for new features. Please create a new issue in the repository to discuss your ideas.

Additional Resources

Documentation: Comprehensive documentation is available on the Calibre-Web wiki.
Community Contributions: Explore the community contributions to see ongoing work and how you can get involved.

Thank you for using Calibre-Web! We hope you enjoy managing your eBook library with our tool.

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 that calibreweb demonstrated a healthy version release cadence and project activity. It has a community of 230 open source contributors collaborating on the 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 December-2024, at 19:27 (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