Skip to content

DLBPointon/brl_scripts

Repository files navigation

BRL_SCRIPTS

STILL IN DEVELOPMENT -- THERE WILL BE BUGS

BRL_scripts is written to generate book-reading-list files (.brl) from an online repository of books. At the minute this is just for Hardcover.app.

The aim is to create a format to easily share reading lists between devices, apps and articles. For instance, it would be nice to see something like Esquires Top 75 Sci-Fi and instead of going through it and add each to your own list on something like Hardcover (They have already made the list here), you could download the list directly onto your device. This comes in real handy for cases where a Universe of books have many interconnecting series and you only want one story through that Universe, e.g. a subseries of a series in a Universe. Another usecase is tracking Official reading orders vs Chronological reading orders as well as the many other community reading orders that may exist.

By all means Hardcover should continue their lists if people want to use it to centralise their reading.

This format is more for people who self host apps such as Kavita. CBL files use a common format for comic book reading lists, and can easily be ingested by many reader apps.

Install

Written on MacOS so linux should be fine too. Python 3.12 scripts.

git clone {repo}

cd {repo}

pip install .

brl the-expanse-chronological


brl --help

positional arguments:
  hardcover_slug        The Hardcover Series slug - Can be found in the URL for a series.

options:
  -h, --help            show this help message and exit
  -e ENVIRONMENTAL_VALUES, --environmental_values ENVIRONMENTAL_VALUES
                        Path to a .env file containing credentials
  -n NAME, --name NAME  Custom name for output file - defaults to the series slug
  -d {Hardcover,Goodreads maybe}, --database {Hardcover,Goodreads maybe}
                        Database to target.
  -c, --include_compilations
                        Should the output include compilations?
  -t, --add_tags        Add the books tags from the database to output
  -o OUTDIR, --outdir OUTDIR
                        Path to output the brl file.
  --debug DEBUG         Debug Info

About

Scripts to aid the generation of brl's from Hardcover

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages