Update

This version has been abandoned, it continues in the fimfic-tracker repository.

If you already have a tracking list, the migrate command is provided to take care of re-formatting the data for you. It should be noted that it doesn't modify the current tracker file nor does it create a new one, you should redirect the output to wherever you need the new file to be.

fimfic-tracker migrate > /path/to/migrated/track-data.json

fimfic-tracker

An unnecessary CLI application for tracking stories on Fimfiction. Because I'm weird and needed an easy way to track some stories without using my account.

Since it's working for me well enough, and that I really had a ton of fun making it, I thought: Why not share it?

Installation · Usage · Configuration · Acknowledgments · License

Installation

Having Python installed is required, at least the 3.7 version.

Use pip to install this project to your system.

# Windows
python -m pip install git+https://github.com/ZodiacalComet/fimfic-tracker-legacy.git

# Linux
python3 -m pip install git+https://github.com/ZodiacalComet/fimfic-tracker-legacy.git

Or you can use pipx instead, which is my personal preference for this kind of Python applications.

pipx install git+https://github.com/ZodiacalComet/fimfic-tracker-legacy.git

Alternately, you could clone this repository with git and install it locally.

git clone https://github.com/ZodiacalComet/fimfic-tracker-legacy.git
cd fimfic-tracker

# With pip
python3 -m pip install -e .

# With pipx
pipx install -e .

Usage

First thing to do is add a story to the tracking list, since there is none at this point, you use the track command like so:

It accepts an unlimited amount of arguments, which means that you can add multiple stories to the tracking list at the same time.

Now that you have some stories tracked, you can use the download command anytime to check for updates:

The downloaded files end up by default in ~/.fimfic-tracker/downloads.

Want to stop tracking a story for whatever reason? You need the ID of the story, which can be seen with the list command:

Now knowing the ID you use the untrack command and, like with the track command, you can specify more than one at once:

Configuration

The application loads its configuration from the following files:

Default config
~/.config/fimfic-tracker/settings.py
~/.fimfic-tracker/settings.py

Feel free to copy the default config and edit to your preferences.

Acknowledgments

To these projects, that made this one less of a headache to make!

Colorama: Simple cross-platform colored terminal text in Python.
Click: Python composable command line interface toolkit.
Requests: A simple, yet elegant HTTP library.

To Carbon for allowing me to make this README a little nicer to look at.

And to these other projects that helped with older versions of this one!

BeautifulSoup4: A program designed for screen-scraping HTML.
Dateparser: python parser for human readable dates.
lxml: The lxml XML toolkit for Python.

License

This simple project is made public under the Unlicense License. So do whateverer you want with it.