Skip to main content

No project description provided

Project description

Chapter-sync

Actions Status codecov Documentation Status Docker

A tool for recording serialized web content, in partial web-serial type novels, or other serialized content for which you want to be sent updates as they're published.

The other tools in the space (at least that I'm aware of: Leech, FanFicFare) are mostly designed around manual one-off usage of the tool to capture the current state of a story/series and turn it into an ebook.

chapter-sync, by contrast, records everything it captures to a sqlite database and will only collect new/missing chapters. It also bakes in (through supported subscription methods) the ability to send new chapters to "subscribers" who have not yet received it.

Quickstart

 chapter-sync series add some-book 'https://some-book.com/table-of-contents/' --title 'Some Book' --settings '{"content_selector": "#main .entry-content", "chapter_selector": "#main .entry-content > ul > li > a"}'
Added series "some-book" at "https://some-book.com/table-of-contents/" chapter-sync series list
┏━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ ID  Name                        URL                                  ┃
┡━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ 1   some-book                   https://some-book.com/table-of-cont… │
└────┴────────────────────────────┴──────────────────────────────────────┘

❯ chapter-sync sync
...
Done

❯ chapter-sync chapter list 1
                               Some Book
┏━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Title       Chapter  Size (Kb)  Sent        Published   Created    ┃
┡━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ Chapter 1   1        37.3       2024-03-02  2023-07-28  2024-03-02 │
│ Chapter 2   2        37.1       2024-03-02  2023-08-04  2024-03-02 │
│ Chapter 3   3        36.9       2024-03-02  2023-08-11  2024-03-02 │
│ Chapter 4   4        36.9       2024-03-02  2023-08-18  2024-03-02 │
└────────────┴─────────┴───────────┴────────────┴────────────┴────────────┘

❯ chapter-sync chapter export 1 4 ls
Some Book: Chapter 4.epub

❯ chapter-sync series export 1 ls
Some Book.epub

Web

The tool also ships with a web service which can be used to view and manage subscriptions.

Web Example

Inspiration

this tool started off as an attempt at a refactor/PR to Leech to enable it to more granularly record updates to books as they changed.

However, chapter-sync is designed from the ground up to be able to individually record/send chapters as they are published, which ultimately means the to tools ultimately end up being almost entirely different.

I had been using InstaPaper to send updates of series to my kindle, until they made that a paid feature. Additionally the drawback there, was that the file they'd send would contain all chapters in the whole series, in reverse.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chapter_sync-0.3.4.tar.gz (40.5 kB view hashes)

Uploaded Source

Built Distribution

chapter_sync-0.3.4-py3-none-any.whl (56.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page