Home

Awesome

Trackma

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

Features

Currently supported websites

Screenshots

Qt interface

Qt

GTK interface

GTK

Curses interface

Curses

CLI

CLI

Dependencies

The only required dependencies to run Trackma are:

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:

UIDependencies
QtPyQt5 (python-pyqt5)
GTK 3PyGI (python3-gi and python3-cairo)
cursesUrwid (python3-urwid)
CLINone

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

TrackerDescriptionDependencies
inotifyInstant, but only supported in Linux. Uses it whenever possible.inotify or pyinotify
PollingSlow, but supported in every POSIX platform. Fallback.lsof
PlexConnects to Plex server. Enabled manually.None
KodiConnects to Kodi server. Enabled manually.None
JellyfinConnects to Jellyfin server. Enabled manually.None
MPRISConnects to running MPRIS capable media players.python3-jeepney
Win32Recognition for Windows platforms.None

Additional optional dependencies:

Installation

Trackma has user-provided packages for several distributions.

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

Manual installation

Make sure you've installed the proper dependencies (listed above) according to the user interface you plan to use, and then run the following 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

Extras (User Interfaces)

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:

ExtraDescription
gtkThe GTK interface.
qtThe Qt interface.
cursesThe curses-based TUI.
uiAll user interfaces.
trackersAll tracker libraries.
discord_rpcSet your watching activity in Discord.
twitterAnnounce your watching activity on Twitter.

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

pip

# 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

poetry

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

Configuration

A configuration file will be created in ~/.config/trackma/config.json, make sure to fill in the directory where 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.

Development

The code is hosted as a git repository on GitHub.

Clone the repo and create the virtual environment using poetry:

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

Use the above commands from the poetry section for how to run your desired interface.

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

License

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

Authors

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