Metadata-Version: 2.4
Name: the-film-flam
Version: 2026.6.7
Summary: FilmFlam (or just "flam") is a commandline tool and API for extracting insights from your movie lists.
Author-email: Aviv Edery <ederyaviv2@gmail.com>
License-Expression: GPL-3.0
Project-URL: Repository, https://github.com/Verpous/film-flam
Project-URL: Documentation, https://verpous.github.io/film-flam
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12.3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorama>=0.4.6
Requires-Dist: concurrent-log-handler>=0.9.29
Requires-Dist: CurrencyConverter>=0.18.18
Requires-Dist: letterboxdpy>=6.5.6
Requires-Dist: msgspec>=0.18.6
Requires-Dist: python-dateutil>=2.9.0.post0
Requires-Dist: requests>=2.34.2
Requires-Dist: selenium>=4.22.0
Dynamic: license-file

# FilmFlam

FilmFlam (or just "flam") is a commandline tool and API for extracting insights from your movie lists.

From the commandline, flam enables you to quickly answer questions like "where have I seen this actor?", or "which director have I seen the most movies from?", and so much more.

For more powerful uses, you can `import flam` and use the underlying API to access all the data about the movies and people in your movie lists.

![find_movies.gif](https://raw.githubusercontent.com/Verpous/film-flam/refs/heads/master/docs/source/_static/find_movies.gif)

![find_tarantino.gif](https://raw.githubusercontent.com/Verpous/film-flam/refs/heads/master/docs/source/_static/find_tarantino.gif)

## Features

* Get **information** about all the movies in your movie list, or about the people in those movies
* **Filter** those movies or people to find something specific
* **Sort** everything and everyone and discover standouts
* **Extend** flam to support custom movie databases, custom filters, and custom attributes
* All in a short and quick commandline
* All in a python API for using from a script

## Installation

Simply:

```
pip install the-film-flam
```

If it worked, great! Otherwise, python probably didn't add the folder where scripts get installed to PATH.
Find where `flam.exe` is installed on your machine - On Windows it will probably be in a folder that looks similar to one of these:

```
%LOCALAPPDATA%\Python\pythoncore-3.14-64\Scripts
%LOCALAPPDATA%\Programs\Python\Python312\Scripts
```

Once you find it, [add the folder to PATH](https://www.thewindowsclub.com/how-to-add-edit-a-path-variable-in-windows) and try again.

## Usage

Read all about how to use flam in [the docs](https://verpous.github.io/film-flam/introduction.html)!

## Supported platforms

Flam is cross-platform and should work on Windows, Linux, and macOS. However, it's only well-tested on Windows, since that is what I am using. Please let me know if you encounter issues.

Flam is better if you have `less` installed. If you're on Windows, it's recommended to install it. One easy way is to just install [git](https://git-scm.com/).

## Getting help

If you encounter issues or have questions, please open an issue, or email me at ederyaviv2@gmail.com.

## Disclaimer

This program uses TMDB and the TMDB APIs but is not endorsed, certified, or otherwise approved by TMDB.

Likewise IMDb, Letterboxd, or what-have-you.

![tmdb.svg](https://raw.githubusercontent.com/Verpous/film-flam/refs/heads/master/docs/source/_static/tmdb.svg)
