| Name | calibreweb JSON |
| Version |
0.6.24
JSON |
| download |
| home_page | None |
| Summary | Web app for browsing, reading and downloading eBooks stored in a Calibre database. |
| upload_time | 2024-11-16 06:50:43 |
| maintainer | @OzzieIsaacs |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | GPLv3+ |
| keywords |
calibre
calibre-web
library
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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](https://calibre-ebook.com) database.
[](https://github.com/janeczku/calibre-web/blob/master/LICENSE)
[](https://github.com/janeczku/calibre-web/releases)
[](https://pypi.org/project/calibreweb/)
[](https://pypi.org/project/calibreweb/)
[](https://discord.gg/h2VsJ2NEfB)
<details>
<summary><strong>Table of Contents</strong> (click to expand)</summary>
1. [About](#calibre-web)
2. [Features](#features)
3. [Installation](#installation)
- [Installation via pip (recommended)](#installation-via-pip-recommended)
- [Quick start](#quick-start)
- [Requirements](#requirements)
4. [Docker Images](#docker-images)
5. [Troubleshooting](#troubleshooting)
6. [Contributor Recognition](#contributor-recognition)
7. [Contact](#contact)
8. [Contributing to Calibre-Web](#contributing-to-calibre-web)
</details>
*This software is a fork of [library](https://github.com/mutschler/calibreserver) and licensed under the GPL v3 License.*
## 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](https://github.com/janeczku/calibre-web/wiki/Translation-Status))
- 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)
1. **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
```
2. **Activate the virtual environment**:
```
source calibre-web-env/bin/activate
```
3. **Install Calibre-Web**: Use pip to install the application:
```
pip install calibreweb
```
4. **Install optional features**: For additional functionality, you may need to install optional features. Refer to [this page](https://github.com/janeczku/calibre-web/wiki/Dependencies-in-Calibre-Web-Linux-and-Windows) for details on what can be installed.
5. **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:
- [Manual installation](https://github.com/janeczku/calibre-web/wiki/Manual-installation)
- [Linux Mint installation](https://github.com/janeczku/calibre-web/wiki/How-To:-Install-Calibre-Web-in-Linux-Mint-19-or-20)
- [Cloud Provider setup](https://github.com/janeczku/calibre-web/wiki/How-To:-Install-Calibre-Web-on-a-Cloud-Provider)
## Quick Start
1. **Access Calibre-Web**: Open your browser and navigate to:
```
http://localhost:8083
```
or for the OPDS catalog:
```
http://localhost:8083/opds
```
2. **Log in**: Use the default admin credentials:
- **Username:** admin
- **Password:** admin123
3. **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.
4. **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".
5. **Google Drive Integration**: For hosting your Calibre library on Google Drive, refer to the [Google Drive integration guide](https://github.com/janeczku/calibre-web/wiki/G-Drive-Setup#using-google-drive-integration).
6. **Admin Configuration**: Configure your instance via the admin page, referring to the [Basic Configuration](https://github.com/janeczku/calibre-web/wiki/Configuration#basic-configuration) and [UI Configuration](https://github.com/janeczku/calibre-web/wiki/Configuration#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](https://ghostscript.com/releases/gsdnld.html) for PDF cover extraction.
- **Windows Users**: Install [libmagic](https://gnuwin32.sourceforge.net/downlinks/file.php) for 32bit python or [libmagic for 64bit python](https://github.com/nscaife/file-windows/releases/tag/20170108), 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](https://hub.docker.com/r/linuxserver/calibre-web)
- **GitHub**: [linuxserver/docker-calibre-web](https://github.com/linuxserver/docker-calibre-web)
- **Optional Calibre layer**: [linuxserver/docker-mods](https://github.com/linuxserver/docker-mods/tree/universal-calibre)
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](https://github.com/janeczku/calibre-web/wiki/FAQ) of the wiki or posting your questions in the [Discord community](https://discord.gg/h2VsJ2NEfB).
## Contributor Recognition
We would like to thank all the [contributors](https://github.com/janeczku/calibre-web/graphs/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](https://discord.gg/h2VsJ2NEfB)
For more information, How To's, and FAQs, please visit the [Wiki](https://github.com/janeczku/calibre-web/wiki)
## Contributing to Calibre-Web
To contribute, please check our [Contributing Guidelines](https://github.com/janeczku/calibre-web/blob/master/CONTRIBUTING.md). 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](https://github.com/janeczku/calibre-web/issues) 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](https://github.com/janeczku/calibre-web/wiki).
- **Community Contributions**: Explore the [community contributions](https://github.com/janeczku/calibre-web/pulls) 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "calibreweb",
"maintainer": "@OzzieIsaacs",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "calibre, calibre-web, library",
"author": null,
"author_email": "\"@OzzieIsaacs\" <Ozzie.Fernandez.Isaacs@googlemail.com>",
"download_url": "https://files.pythonhosted.org/packages/ca/14/003513f84829bd03c21ca462bab53c9eec41e7990a974c76f6882130f02a/calibreweb-0.6.24.tar.gz",
"platform": null,
"description": "# Calibre-Web\n\nCalibre-Web is a web app that offers a clean and intuitive interface for browsing, reading, and downloading eBooks using a valid [Calibre](https://calibre-ebook.com) database.\n\n[](https://github.com/janeczku/calibre-web/blob/master/LICENSE)\n\n[](https://github.com/janeczku/calibre-web/releases)\n[](https://pypi.org/project/calibreweb/)\n[](https://pypi.org/project/calibreweb/)\n[](https://discord.gg/h2VsJ2NEfB)\n\n<details>\n<summary><strong>Table of Contents</strong> (click to expand)</summary>\n\n1. [About](#calibre-web)\n2. [Features](#features)\n3. [Installation](#installation)\n - [Installation via pip (recommended)](#installation-via-pip-recommended)\n - [Quick start](#quick-start)\n - [Requirements](#requirements)\n4. [Docker Images](#docker-images)\n5. [Troubleshooting](#troubleshooting)\n6. [Contributor Recognition](#contributor-recognition)\n7. [Contact](#contact)\n8. [Contributing to Calibre-Web](#contributing-to-calibre-web)\n\n</details>\n\n*This software is a fork of [library](https://github.com/mutschler/calibreserver) and licensed under the GPL v3 License.*\n\n\n\n## Features\n\n- Modern and responsive Bootstrap 3 HTML5 interface\n- Full graphical setup\n- Comprehensive user management with fine-grained per-user permissions\n- Admin interface\n- Multilingual user interface supporting 20+ languages ([supported languages](https://github.com/janeczku/calibre-web/wiki/Translation-Status))\n- OPDS feed for eBook reader apps\n- Advanced search and filtering options\n- Custom book collection (shelves) creation\n- eBook metadata editing and deletion support\n- Metadata download from various sources (extensible via plugins)\n- eBook conversion through Calibre binaries\n- eBook download restriction to logged-in users\n- Public user registration support\n- Send eBooks to E-Readers with a single click\n- Sync Kobo devices with your Calibre library\n- In-browser eBook reading support for multiple formats\n- Upload new books in various formats, including audio formats\n- Calibre Custom Columns support\n- Content hiding based on categories and Custom Column content per user\n- Self-update capability\n- \"Magic Link\" login for easy access on eReaders\n- LDAP, Google/GitHub OAuth, and proxy authentication support\n\n## Installation\n\n### Installation via pip (recommended)\n\n1. **Create a virtual environment**: It\u2019s essential to isolate your Calibre-Web installation to avoid dependency conflicts. You can create a virtual environment by running:\n ```\n python3 -m venv calibre-web-env\n ```\n2. **Activate the virtual environment**:\n ```\n source calibre-web-env/bin/activate\n ```\n3. **Install Calibre-Web**: Use pip to install the application:\n ```\n pip install calibreweb\n ```\n4. **Install optional features**: For additional functionality, you may need to install optional features. Refer to [this page](https://github.com/janeczku/calibre-web/wiki/Dependencies-in-Calibre-Web-Linux-and-Windows) for details on what can be installed.\n5. **Start Calibre-Web**: After installation, you can start the application with:\n ```\n cps\n ```\n\n*Note: Users of Raspberry Pi OS may encounter installation issues. If you do, try upgrading pip and/or installing cargo as follows:*\n ```\n ./venv/bin/python3 -m pip install --upgrade pip\n sudo apt install cargo\n ```\n\n### Important Links\n- For additional installation examples, check the following:\n - [Manual installation](https://github.com/janeczku/calibre-web/wiki/Manual-installation)\n - [Linux Mint installation](https://github.com/janeczku/calibre-web/wiki/How-To:-Install-Calibre-Web-in-Linux-Mint-19-or-20)\n - [Cloud Provider setup](https://github.com/janeczku/calibre-web/wiki/How-To:-Install-Calibre-Web-on-a-Cloud-Provider)\n\n## Quick Start\n\n1. **Access Calibre-Web**: Open your browser and navigate to:\n ```\n http://localhost:8083\n ```\n or for the OPDS catalog:\n ```\n http://localhost:8083/opds\n ```\n2. **Log in**: Use the default admin credentials:\n - **Username:** admin\n - **Password:** admin123\n3. **Database Setup**: If you do not have a Calibre database, download a sample from:\n ```\n https://github.com/janeczku/calibre-web/raw/master/library/metadata.db\n ```\n Move it out of the Calibre-Web folder to avoid overwriting during updates.\n4. **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\".\n5. **Google Drive Integration**: For hosting your Calibre library on Google Drive, refer to the [Google Drive integration guide](https://github.com/janeczku/calibre-web/wiki/G-Drive-Setup#using-google-drive-integration).\n6. **Admin Configuration**: Configure your instance via the admin page, referring to the [Basic Configuration](https://github.com/janeczku/calibre-web/wiki/Configuration#basic-configuration) and [UI Configuration](https://github.com/janeczku/calibre-web/wiki/Configuration#ui-configuration) guides.\n\n## Requirements\n\n- **Python Version**: Ensure you have Python 3.7 or newer.\n- **Imagemagick**: Required for cover extraction from EPUBs. Windows users may also need to install [Ghostscript](https://ghostscript.com/releases/gsdnld.html) for PDF cover extraction.\n- **Windows Users**: Install [libmagic](https://gnuwin32.sourceforge.net/downlinks/file.php) for 32bit python or [libmagic for 64bit python](https://github.com/nscaife/file-windows/releases/tag/20170108), depending on your Python version. Make sure these files are included in your path.\n- **Optional Tools**:\n - **Calibre desktop program**: Recommended for on-the-fly conversion and metadata editing. Set the path to Calibre\u2019s converter tool on the setup page.\n - **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.\n\n## Docker Images\n\nPre-built Docker images are available:\n\n### **LinuxServer - x64, aarch64**\n- **Docker Hub**: [linuxserver/calibre-web](https://hub.docker.com/r/linuxserver/calibre-web)\n- **GitHub**: [linuxserver/docker-calibre-web](https://github.com/linuxserver/docker-calibre-web)\n- **Optional Calibre layer**: [linuxserver/docker-mods](https://github.com/linuxserver/docker-mods/tree/universal-calibre)\n\nTo include the Calibre `ebook-convert` binary (x64 only), add the environment variable:\n``` \nDOCKER_MODS=linuxserver/mods:universal-calibre\n```\nin your Docker run/compose file. Omit this variable for a lightweight image.\n\n- **Paths Configuration**:\n - Set **Path to Calibre Binaries** to `/usr/bin`.\n - Set **Path to Unrar** to `/usr/bin/unrar`.\n\n## Troubleshooting\n\n- **Common Issues**: \n - If you experience issues starting the application, check the log files located in the `logs` directory for error messages.\n - If eBooks fail to load, verify that the `Location of Calibre database` is correctly set and that the database file is accessible.\n\n- **Configuration Errors**: Ensure that your Calibre database is compatible and properly formatted. Refer to the Calibre documentation for guidance on maintaining the database.\n\n- **Performance Problems**: \n - 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.\n - Regularly clear the cache in your web browser to improve loading times.\n\n- **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.\n\n- **Support Resources**: For additional help, consider visiting the [FAQ section](https://github.com/janeczku/calibre-web/wiki/FAQ) of the wiki or posting your questions in the [Discord community](https://discord.gg/h2VsJ2NEfB).\n\n## Contributor Recognition\n\nWe would like to thank all the [contributors](https://github.com/janeczku/calibre-web/graphs/contributors) and maintainers of Calibre-Web for their valuable input and dedication to the project. Your contributions are greatly appreciated.\n\n## Contact\n\nJoin us on [Discord](https://discord.gg/h2VsJ2NEfB)\n\nFor more information, How To's, and FAQs, please visit the [Wiki](https://github.com/janeczku/calibre-web/wiki)\n\n## Contributing to Calibre-Web\n\nTo contribute, please check our [Contributing Guidelines](https://github.com/janeczku/calibre-web/blob/master/CONTRIBUTING.md). We welcome issues, feature requests, and pull requests from the community.\n\n### Reporting Bugs\n\nIf you encounter bugs or issues, please report them in the [issues section](https://github.com/janeczku/calibre-web/issues) of the repository. Be sure to include detailed information about your setup and the problem encountered.\n\n### Feature Requests\n\nWe welcome suggestions for new features. Please create a new issue in the repository to discuss your ideas.\n\n## Additional Resources\n\n- **Documentation**: Comprehensive documentation is available on the [Calibre-Web wiki](https://github.com/janeczku/calibre-web/wiki).\n- **Community Contributions**: Explore the [community contributions](https://github.com/janeczku/calibre-web/pulls) to see ongoing work and how you can get involved.\n\n---\n\nThank you for using Calibre-Web! We hope you enjoy managing your eBook library with our tool.\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Web app for browsing, reading and downloading eBooks stored in a Calibre database.",
"version": "0.6.24",
"project_urls": {
"Bug Tracker": "https://github.com/janeczku/calibre-web/issues",
"Documentation": "https://github.com/janeczku/calibre-web/wiki",
"Homepage": "https://github.com/janeczku/calibre-web",
"Release Management": "https://github.com/janeczku/calibre-web/releases",
"Source Code": "https://github.com/janeczku/calibre-web"
},
"split_keywords": [
"calibre",
" calibre-web",
" library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d5e817c99aa6b51c5b950666cd2a7d9468e5648c0d3bb7d50a3243a3f28a9b6",
"md5": "bc224bf98539ead9de4b650eab0db4cf",
"sha256": "96aee42390478c06699e2745511ff9424c06b48561ba261fbd3a74de9ff845be"
},
"downloads": -1,
"filename": "calibreweb-0.6.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc224bf98539ead9de4b650eab0db4cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7925423,
"upload_time": "2024-11-16T06:50:36",
"upload_time_iso_8601": "2024-11-16T06:50:36.268634Z",
"url": "https://files.pythonhosted.org/packages/3d/5e/817c99aa6b51c5b950666cd2a7d9468e5648c0d3bb7d50a3243a3f28a9b6/calibreweb-0.6.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca14003513f84829bd03c21ca462bab53c9eec41e7990a974c76f6882130f02a",
"md5": "2fe65237cad9d0ffb2ae8705d4f9a947",
"sha256": "883c956ceb93a9bfa758428904d4122e64a1cf4778e5b6df14b8e50f465b6f9e"
},
"downloads": -1,
"filename": "calibreweb-0.6.24.tar.gz",
"has_sig": false,
"md5_digest": "2fe65237cad9d0ffb2ae8705d4f9a947",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7126198,
"upload_time": "2024-11-16T06:50:43",
"upload_time_iso_8601": "2024-11-16T06:50:43.351394Z",
"url": "https://files.pythonhosted.org/packages/ca/14/003513f84829bd03c21ca462bab53c9eec41e7990a974c76f6882130f02a/calibreweb-0.6.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-16 06:50:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "janeczku",
"github_project": "calibre-web",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "calibreweb"
}
