A toolkit to manage movie collections.
Project description
filmfarm
A toolkit to manage movie collections. It provides utilities to scrape metadata/posters and organize movies into directories based on their metadata.
It's useful if you have a film collection in a directory where each film is in its own subdirectory named after the IMDB ID of the film. This is easier to demonstrate than explain; in the demo the directories are empty, but in real life they could contain video files from your DVD backups etc.
Installation
filmfarm is best installed using pipx; pipx install filmfarm
.
Usage
filmfarm provides a command-line interface (CLI) using Typer.
See filmfarm --help
for details.
Prerequisites
filmfarm requires API keys for OMDB and TMDB, as of this writing these keys are freely
available. You must set OMDB_API_KEY
and TMDB_API_KEY
in your environment, or create a dotenv
file in the project's directory if you're running from source.
Development
filmfarm is packaged with Poetry. Once Poetry is installed and you've
cloned the filmfarm source repo, run poetry install
to install all dependencies. You can then run
poetry run filmfarm
or use poetry shell
(see Poetry docs for details).
To run the tests, use pytest
. There's also integration.sh
, a little shell script which sort of
does integration tests (it actually uses API keys to download and link some data).
Attribution
This package uses the TMDB API but is not endorsed or certified by TMDB. It also uses the OMDB API. A tiny sample of API results is included as testdata.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.