ePUB to reMarkable Converter

This is a web application to convert epubs into a PDF compatible with the reMarkable Paper Pro and Boox Air 4C.

This project has been heavily influenced by AI tooling of claude.ai.

Caution

Due to the software architecture and the handling of temporary files and downloads I strongly recommend not to use it as a public webservice.

Screenshots

Upload interface

Custom parameters

Conversion progress reporting

Finished conversion

Environment variables

Here's a list of all environment variables that can be used to configure the application:

Variable	Description	Default Value
`DEBUG_MODE`	Enable debug mode for more verbose logging	`false`
`TEMP_DIR`	Directory for temporary files	`/tmp`
`JOB_TIMEOUT`	Time (in seconds) that conversion results remain available after completion	`300`
`GUNICORN_TIMEOUT`	Timeout for the Gunicorn worker (in seconds)	`300`
`VIRTUAL_HOST`	Hostname for Nginx proxy	-
`LETSENCRYPT_HOST`	Hostname for Let's Encrypt SSL	-
`LETSENCRYPT_EMAIL`	Email address for Let's Encrypt notifications	-
reMarkable Profile
`REMARKABLE_INPUT_PROFILE`	Input profile for reMarkable Paper Pro	`default`
`REMARKABLE_OUTPUT_PROFILE`	Output profile for reMarkable Paper Pro	`generic_eink_hd`
`REMARKABLE_BASE_FONT_SIZE`	Base font size for reMarkable Paper Pro	`12`
`REMARKABLE_DEFAULT_FONT_SIZE`	Default font size for reMarkable Paper Pro	`18`
`REMARKABLE_MONO_FONT_SIZE`	Monospace font size for reMarkable Paper Pro	`16`
`REMARKABLE_CUSTOM_SIZE`	Custom size (width x height) for reMarkable Paper Pro	`1620x2160`
`REMARKABLE_UNIT`	Unit for custom size for reMarkable Paper Pro	`pixel`
`REMARKABLE_PDF_SANS_FAMILY`	Sans font family for reMarkable Paper Pro	`IBM Plex Sans`
`REMARKABLE_PDF_SERIF_FAMILY`	Serif font family for reMarkable Paper Pro	`IBM Plex Serif`
`REMARKABLE_PDF_MONO_FAMILY`	Monospace font family for reMarkable Paper Pro	`IBM Plex Mono`
`REMARKABLE_PDF_STANDARD_FONT`	Standard font for reMarkable Paper Pro	`serif`
`REMARKABLE_PDF_PAGE_MARGIN_LEFT`	Left page margin for reMarkable Paper Pro	`72`
`REMARKABLE_PDF_PAGE_MARGIN_RIGHT`	Right page margin for reMarkable Paper Pro	`20`
`REMARKABLE_PDF_PAGE_MARGIN_TOP`	Top page margin for reMarkable Paper Pro	`20`
`REMARKABLE_PDF_PAGE_MARGIN_BOTTOM`	Bottom page margin for reMarkable Paper Pro	`20`
`REMARKABLE_EMBED_ALL_FONTS`	Embed all fonts in PDF for reMarkable Paper Pro	`true`
`REMARKABLE_SUBSET_EMBEDDED_FONTS`	Subset embedded fonts for reMarkable Paper Pro	`true`
`REMARKABLE_UNSMARTEN_PUNCTUATION`	Simplify punctuation for reMarkable Paper Pro	`true`
`REMARKABLE_PRESERVE_COVER_ASPECT_RATIO`	Preserve cover aspect ratio for reMarkable Paper Pro	`true`
`REMARKABLE_CHANGE_JUSTIFICATION`	Text justification for reMarkable Paper Pro	`justify`
Boox Air 4C Profile
`BOOX_AIR_4C_INPUT_PROFILE`	Input profile for Boox Air 4C	`default`
`BOOX_AIR_4C_OUTPUT_PROFILE`	Output profile for Boox Air 4C	`generic_eink_hd`
`BOOX_AIR_4C_BASE_FONT_SIZE`	Base font size for Boox Air 4C	`12`
`BOOX_AIR_4C_DEFAULT_FONT_SIZE`	Default font size for Boox Air 4C	`16`
`BOOX_AIR_4C_MONO_FONT_SIZE`	Monospace font size for Boox Air 4C	`14`
`BOOX_AIR_4C_CUSTOM_SIZE`	Custom size (width x height) for Boox Air 4C	`1860x2480`
`BOOX_AIR_4C_UNIT`	Unit for custom size for Boox Air 4C	`pixel`
`BOOX_AIR_4C_PDF_SANS_FAMILY`	Sans font family for Boox Air 4C	`IBM Plex Sans`
`BOOX_AIR_4C_PDF_SERIF_FAMILY`	Serif font family for Boox Air 4C	`IBM Plex Serif`
`BOOX_AIR_4C_PDF_MONO_FAMILY`	Monospace font family for Boox Air 4C	`IBM Plex Mono`
`BOOX_AIR_4C_PDF_STANDARD_FONT`	Standard font for Boox Air 4C	`serif`
`BOOX_AIR_4C_PDF_PAGE_MARGIN_LEFT`	Left page margin for Boox Air 4C	`72`
`BOOX_AIR_4C_PDF_PAGE_MARGIN_RIGHT`	Right page margin for Boox Air 4C	`20`
`BOOX_AIR_4C_PDF_PAGE_MARGIN_TOP`	Top page margin for Boox Air 4C	`20`
`BOOX_AIR_4C_PDF_PAGE_MARGIN_BOTTOM`	Bottom page margin for Boox Air 4C	`20`
`BOOX_AIR_4C_EMBED_ALL_FONTS`	Embed all fonts in PDF for Boox Air 4C	`true`
`BOOX_AIR_4C_SUBSET_EMBEDDED_FONTS`	Subset embedded fonts for Boox Air 4C	`true`
`BOOX_AIR_4C_UNSMARTEN_PUNCTUATION`	Simplify punctuation for Boox Air 4C	`true`
`BOOX_AIR_4C_PRESERVE_COVER_ASPECT_RATIO`	Preserve cover aspect ratio for Boox Air 4C	`true`
`BOOX_AIR_4C_CHANGE_JUSTIFICATION`	Text justification for Boox Air 4C	`justify`

The application can be configured using these environment variables in the .env file or directly in the docker-compose.yml.

REST API

This document describes the REST API for the eBook to PDF converter. The API allows you to convert EPUB files to PDF programmatically, check conversion status, and download the converted files.

API Endpoints

Health Check

GET /api/v1/health

Check if the API and Calibre services are running correctly.

Response:

{
  "status": "operational",
  "api_version": "1.0.0",
  "calibre": {
    "status": "available",
    "version": "6.4.0"
  }
}

Get Device Profiles

GET /api/v1/device_profiles

Retrieve all available device profiles and their parameters.

Response:

{
  "reMarkable": {
    "input_profile": "default",
    "output_profile": "generic_eink_hd",
    "base_font_size": "12",
    ...
  },
  "boox_air_4c": {
    "input_profile": "default",
    "output_profile": "generic_eink_hd",
    "base_font_size": "12",
    ...
  }
}

Convert EPUB to PDF

POST /api/v1/convert

Convert an EPUB file to PDF. This is an asynchronous operation that returns a job ID.

Request: multipart/form-data

Parameter	Required	Description
epub_file	Yes	The EPUB file to convert
device_profile	No	Device profile to use (reMarkable, boox_air_4c, or custom)

If using a custom profile, you can include any or all of the following parameters:

input_profile
output_profile
base_font_size
default_font_size
mono_font_size
embed_all_fonts (true/false)
subset_embedded_fonts (true/false)
unsmarten_punctuation (true/false)
custom_size
unit
pdf_sans_family
pdf_serif_family
pdf_mono_family
pdf_standard_font
pdf_page_margin_left
pdf_page_margin_right
pdf_page_margin_top
pdf_page_margin_bottom
preserve_cover_aspect_ratio (true/false)
change_justification

Response:

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status_url": "http://example.com/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000/status",
  "download_url": "http://example.com/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000/download",
  "status": "processing"
}

Check Conversion Status

GET /api/v1/jobs/{job_id}/status

Check the status of a conversion job.

Parameters:

Parameter	Type	Description
job_id	string	The job ID returned from the convert endpoint

Response:

{
  "status": "running",
  "progress": 45,
  "message": "Converting page 45/100",
  "logs": [
    "Starting conversion...",
    "Converting page 44/100",
    "Converting page 45/100"
  ]
}

When the conversion is completed:

{
  "status": "completed",
  "progress": 100,
  "message": "Conversion completed successfully",
  "download_url": "http://example.com/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000/download"
}

If the conversion fails:

{
  "status": "failed",
  "progress": 67,
  "message": "Conversion failed with code 1",
  "logs": [
    "Error: Unable to convert page 67",
    "Process terminated abnormally"
  ]
}

Download Converted PDF

GET /api/v1/jobs/{job_id}/download

Download the converted PDF file.

Parameters:

Parameter	Type	Description
job_id	string	The job ID returned from the convert endpoint

Response:

The PDF file as a binary stream with Content-Type: application/pdf.

Example Usage

Using cURL

# Health check
curl -X GET http://example.com/api/v1/health

# Get device profiles
curl -X GET http://example.com/api/v1/device_profiles

# Convert EPUB to PDF
curl -X POST http://example.com/api/v1/convert \
  -F "epub_file=@/path/to/book.epub" \
  -F "device_profile=reMarkable"

# Check conversion status
curl -X GET http://example.com/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000/status

# Download converted PDF
curl -X GET http://example.com/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000/download \
  -o converted.pdf

Using Python

import requests

# Health check
response = requests.get("http://example.com/api/v1/health")
print(response.json())

# Convert EPUB to PDF
with open('/path/to/book.epub', 'rb') as f:
    files = {'epub_file': f}
    data = {'device_profile': 'reMarkable'}
    response = requests.post("http://example.com/api/v1/convert", files=files, data=data)

job_data = response.json()
job_id = job_data['job_id']
print(f"Job ID: {job_id}")

# Check conversion status
status_url = job_data['status_url']
status_response = requests.get(status_url)
print(status_response.json())

# Download converted PDF when ready
if status_response.json()['status'] == 'completed':
    download_url = status_response.json()['download_url']
    pdf_response = requests.get(download_url)
    
    with open('converted.pdf', 'wb') as f:
        f.write(pdf_response.content)
    print("PDF downloaded successfully")

Error Codes

HTTP Status	Description
200	Success
202	Accepted (for conversion requests)
400	Bad Request (missing file or invalid parameters)
404	Not Found (job ID not found)
500	Server Error

Name		Name	Last commit message	Last commit date
Latest commit History 32 Commits
.github/workflows		.github/workflows
screenshots		screenshots
templates		templates
.env.example		.env.example
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
app.py		app.py
docker-compose.yml		docker-compose.yml
requirements.txt		requirements.txt

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

ePUB to reMarkable Converter

Screenshots

Upload interface

Custom parameters

Conversion progress reporting

Finished conversion

Environment variables

REST API

API Endpoints

Health Check

Get Device Profiles

Convert EPUB to PDF

Check Conversion Status

Download Converted PDF

Example Usage

Using cURL

Using Python

Error Codes

About

Releases 6

Packages

Languages

License

suntorytimed/epub_to_remarkable

Folders and files

Latest commit

History

Repository files navigation

ePUB to reMarkable Converter

Screenshots

Upload interface

Custom parameters

Conversion progress reporting

Finished conversion

Environment variables

REST API

API Endpoints

Health Check

Get Device Profiles

Convert EPUB to PDF

Check Conversion Status

Download Converted PDF

Example Usage

Using cURL

Using Python

Error Codes

About

Resources

License

Stars

Watchers

Forks

Releases 6

Packages 0

Languages

Packages