Hazel/scribble_to_epub
1
0
Fork 0
generated from Hazel/python-project
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation

Browse Source
This commit is contained in:
Hazel Noack 2025-06-10 16:35:14 +02:00
parent ba4875d27a
commit eee7212f6b
2 changed files with 53 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -160,3 +160,5 @@ cython_debug/
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
*.epub

54
README.md
View File

@ -1,5 +1,53 @@
# Scribble_to_epub
# Scribble to EPUB
This scrapes books from https://www.scribblehub.com/ and creates epub from them.
A command-line tool to convert ScribbleHub stories into EPUB format.
Inspired by [py-scribblehub-to-epub](https://github.com/agmlego/py-scribblehub-to-epub). Thanks.
## Description
This tool scrapes books from [ScribbleHub](https://www.scribblehub.com/) and converts them into EPUB files for offline reading. It preserves chapter structure and includes author information and other metadata.
## Features
- Converts ScribbleHub stories to EPUB format
- Preserves chapter structure and titles
- Includes author information and notes (by default)
- Customizable output filename
## Installation
```bash
pip install scribble-to-epub
```
## Usage
```bash
scribble-to-epub [OPTIONS] URL
```
### Options
| Option | Description |
|--------|-------------|
| `--output OUTPUT` | Optional output file name for the EPUB |
| `--disable-author-quotes` | Disable author quotes in the EPUB (default: False) |
### Example
```bash
scribble-to-epub https://www.scribblehub.com/series/123456/story-title/
```
## Credits
This project uses significant code from [agmlego/py-scribblehub-to-epub](https://github.com/agmlego/py-scribblehub-to-epub). Many thanks to the original author for their work.
## License
This project is licensed under the **Opinionated Queer License v1.2**. So use is strictly prohibited for cops, military and everyone who doesn't like human rights.
## Notes
The default behavior includes author quotes in the EPUB to show appreciation for the author's work. While there's an option to disable this (`--disable-author-quotes`), it's recommended to keep them enabled to support the authors.
If you encounter any issues with the EPUB formatting of author notes, please consider reporting them as issues rather than immediately disabling the quotes.