Repository files navigation

Trackma aims to be a lightweight and simple but feature-rich program for Unix based systemsfor fetching, updating and using data from personal lists hosted in several media tracking websites.

• Manage local list and synchronize when necessary, useful when offline
• Manage multiple accounts on different media tracking sites
• Support for several media types (as supported by the site)
• Multiple user interfaces (Qt, GTK, curses, command-line)
• Detection of running media player, updates list if necessary
• Ability to launch media player for a requested media in the list and update list if necessary
• Highly scalable, easy to code new interfaces and support for other sites
• Secure, uses HTTPS wherever possible.

• Anilist (Anime, Manga)
• Kitsu (Anime, Manga, Drama)
• MyAnimeList (Anime, Manga)
• Shikimori (Anime, Manga)
• VNDB (VNs)

Qt interface

GTK interface

Curses interface

CLI

The only required dependencies to run Trackma are:

• Python 3.8+
• python3-requests
• For installation:python3-pip (to install throughpip)orpython3-poetry (to install throughpoetry)

But only basic features will work (only CLI interface and no tracker). Everything else is optional.

The following user interfaces are available and their requirements are as follows:

The following media recognition trackers are available and their requirements are as follows:

Additional optional dependencies:

• PIL (python3-pil) - for showing preview images in the Qt/GTK interfaces.
• pypresence (???) - for announcing activity on Discord.
• twitter (python3-twitter) - for announcing activity on Twitter.

Trackma has user-provided packages for several distributions.

• Arch Linux:https://aur.archlinux.org/packages/trackma,http://aur.archlinux.org/packages/trackma-git
• Fedora:https://copr.fedoraproject.org/coprs/dyskette/trackma/
• Gentoo Linux:http://gpo.zugaina.org/net-misc/trackma
• NixOS:https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/trackma/default.nix
• Void Linux:https://github.com/void-linux/void-packages/blob/master/srcpkgs/trackma/template

A user from the community also is providing a Docker image:

• Docker:https://hub.docker.com/r/frosty5689/trackma/

Make sure you've installed the proper dependencies (listed above)according to the user interface you plan to use, and then run thefollowing command:

$ pip3 install Trackma

You can also install the git (probably unstable, but newer) version like this:

$ pip3 install -U git+https://github.com/z411/trackma.git

Or download the source code and install:

$ git clone --recursive https://github.com/z411/trackma.git$cd trackma$ poetry build$ pip3 install dist/trackma-0.8.5-py3-none-any.whl

All user interfaces except for the default CLI mode require additional dependencies to function.You may specify these as "extras" to be installed by the Python package manager.

The following extras are available:

If you want to install any of the extras be sure to specify them during installation:

# With pip$ pip3 install Trackma[gtk,trackers,curses]$ pip3 install Trackma[ui,twitter,discord_rpc]

Note that pip does not have a way to install all available extras,so you'll have to provide them all manually if desired.

Then you can run the program with the interface you like.

$ trackma$ trackma-curses$ trackma-gtk$ trackma-qt

When using poetry on the cloned repository (see above),you can install your desired extras as follows:

$ poetry install -E gtk -E trackers -E curses$ poetry install -E ui -E twitter -E discord_rpc$ poetry install --all-extras

Then you can run the interface you like in your virtual environment managed by poetry:

$ poetry run trackma$ poetry run trackma-curses$ poetry run trackma-gtk$ poetry run trackma-qt

A configuration file will be created in~/.config/trackma/config.json, make sure to fill in the directorywhere you store your video files and other settings. Details about what each option does can be done here:

https://github.com/z411/trackma/wiki/Configuration-File

Alternatively, the GTK and Qt interfaces provide a visual Settings panel.

The code is hosted as a git repository onGitHub.

Clone the repo and create the virtual environment usingpoetry:

$ git clone --recursive https://github.com/z411/trackma.git$cd trackma$ poetry install --all-extras$ poetry shell

Use the above commands from thepoetry sectionfor how to run your desired interface.

If you encounter any problems or have anything to suggest, please don'thesitate to submit an issue in the GitHubissue tracker.

Trackma is licensed under the GPLv3 license, please seeLICENSE for details.

Trackma was originally written by z411z411@omaera.org. For other contributors see AUTHORS file. GTK icon designed by shuuichi.