PyOPDS Server - OPDS Server for EPUB Library

This project is a lightweight OPDS (Open Publication Distribution System) server written in Python 3, designed to expose a library of EPUB files stored in a local directory, compatible with clients like Calibre, KoReader, or any other OPDS-compliant reader. It uses only Python's standard libraries.

If you browse your OPDS feed in a web browser, it will display a simple HTML representation of the feed using XSLT transformation.

Features

• OPDS Catalog: Exposes EPUB books via an OPDS feed accessible at the /opds endpoint.
• OpenSearch: Integrated search functionality compliant with OpenSearch specification, allowing users to search books by title or author.
• Subdirectory Support: Scans EPUB files in the configured directory and its subdirectories.
• Sorted by Most Recent: Books are listed in the OPDS feed sorted by modification date, with the most recently modified files appearing first.
• Metadata Extraction: Extracts title and author from EPUB files for rich display in the catalog.
• KoReader Sync API: Optional JSON endpoints that store and replay reading progress shared by KoReader devices.
• Docker Deployment: Includes a Dockerfile and docker-compose.yml for easy containerized deployment.
• Visual HTML Representation: Provides a simple HTML view of the OPDS feed for easy browsing in web browsers (using XSLT transformation).

Prerequisites

• Python 3.12+ (if running without Docker).
• Docker and Docker Compose (for containerized deployment).
• A directory containing EPUB files (e.g., books/).

Installation

With Docker

1. Clone the repository:

   git clone https://github.com/your-username/your-repo.git
   cd your-repo

2. Create a books/ directory and place your EPUB files in it (e.g., books/author1/book.epub).

3. Start the server with Docker Compose:

   docker-compose up --build

4. Access the OPDS catalog at: http://localhost:8080/opds.

Without Docker

1. Clone the repository:

   git clone https://github.com/your-username/your-repo.git
   cd your-repo

2. Set the environment variable for the books directory:

   export LIBRARY_DIR=/path/to/your/books

3. Start the server:

   python server.py

4. Access the OPDS catalog at: http://localhost:8080/opds.

Configuration

The following environment variables can be set:

• LIBRARY_DIR: Path to the directory containing EPUB files (default: books).
• KOREADER_SYNC_DB_PATH: Path to the SQLite database file used by the KoReader sync helper (default: koreader_sync.db).

For Docker, modify these variables in the docker-compose.yml file:

services:
  opds-server:
    build: .
    ports:
      - "8080:8080"
    volumes:
      - ./books:/books
      - ./config:/config
    environment:
      - LIBRARY_DIR=/books
      - KOREADER_SYNC_DB_PATH=/config/koreader_sync.db
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8080/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 5s

Usage with an OPDS Client

1. In an OPDS-compatible client (e.g., KoReader or Calibre):
   • Add a new catalog with the URL: http://<your-ip>:8080/opds.
2. Browse the book list at the /opds/books endpoint.
3. Download books via the links provided in the OPDS feed.

KoReader Sync API

The server exposes lightweight sync endpoints that allow KoReader clients to upload and download reading progress.

Endpoints

• PUT /koreader/sync/syncs/progress: Accepts JSON payloads containing reading progress data from KoReader devices.
• GET /koreader/sync/syncs/progress/{book_id}: Retrieves stored progress data for a specific book.

Data is stored in a local SQLite database (KOREADER_SYNC_DB_PATH) and deduplicated by the combination of user, device, and document identifier.

Security Consideration

This server is designed to be lightweight and does not include built-in authentication or HTTPS support. For production use, it is strongly recommended to place the server behind a reverse proxy (e.g., SWAG, Nginx, or Nginx Proxy Manager).

License

This project is licensed under the MIT License. See the LICENSE file for details (to be added if necessary).