Skip to content

Latest commit

 

History

History

formula1

README.md

Formula 1 metadata generator

This will generate some metadata for your Formula 1 folder.

Expected Organization

For the round (or "episode") name, it is expected as described in the jellyfin documentation. In short, just be sure to have a sXXXeYYY name where, XXX is the season number and YYY is the round number:

Whatever name - s2003e12 - whatever here.

For the folder structure, I expect something like this:

.
└── Root(your show library, e.g.: sports)
    └── Formula 1
        ├── season 2010
        │   ├── Formula 1 - s2010e02 - Australian Grand Prix.avi
        │   └── ...
        └── season 2023
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - FP1 2160p50.mp4
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - FP2 2160p50.mp4
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - FP3 2160p50.mp4
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - Qualification 2160p50.mp4
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - Race 2160p50.mkv
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - Sprint 2160p50.mkv
            └── ...

We just need to make sure that Sprint metadata contains a date before the Race.

What will it do?

It will generate the .nfo files, get posters and all the good stuff... Similar to what Jellyfin automatically does by using, e.g., the movie DB.

Your folder will become something like:

.
└── Root(your show library, e.g.: sports)
    └── Formula 1
        ├── backdrop.jpg
        ├── logo.png
        ├── folder.jpg
        ├── tvshow.nfo
        ├── season 2010
        │   ├── Formula 1 - s2010e02 - Australian Grand Prix.avi
        │   ├── <...>
        │   ├── Formula 1 - s2010e02 - Australian Grand Prix.nfo
        │   ├── <...>
        │   ├── metadata
        │   │   ├── Formula 1 - s2010e02 - Australian Grand Prix.jpg
        │   │   └── <...>
        │   ├── folder.jpg
        │   └── season.nfo
        └── season 2023
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - Race 2160p50.mp4
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - Sprint 2160p50.mp4
            ├── <...>
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - Race 2160p50.nfo
            ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - Sprint 2160p50.nfo
            ├── metadata
            │   ├── Formula 1 - s2023e20 - Sao Paulo Grand Prix - Race 2160p50.jpg
            │   └── <...>
            ├── folder.jpg
            └── season.nfo

How does it work?

  • It will fetch the data from ergast. I wrote a small wrapper because they said that the service will be discontinued by the end of 2024 :(
  • It will download the race posters from Event Artworks
  • The race and season description is taken from Wikipedia.
  • It will not overwrite existing metadata files, if you want a new one, then delete the previous one.

How do I use it?

  • Check the help section: python3 Main.py -h
  • Example: python3 Main.py /path/to/my/f1/library
  • Are you using a docker container for Jellyfin? Then: python3 Main.py /path/to/my/f1/library --mapped-folder /media/shows/f1
  • Don't like the webp format? Add --convert-to-jpg. Requires Pillow to work.
    • Example: python3 Main.py /path/to/my/f1/library --mapped-folder /media/shows/f1 --convert-to-jpg
    • Example: python3 Main.py /path/to/my/f1/library --convert-to-jpg

Configuration file

This is some configuration for your library, in case you are using something different from mine. Check the config.json file, each value is:

  • freePractice: The string that identify that your video is a free practice, this is in case where all the practices are in a single video. E.g.: Formula 1 - s2023e20 - Sao Paulo Grand Prix - free practice 2160p50.mp4
  • fp1: The string that identify that your video is a free practice 1. E.g.: Formula 1 - s2023e20 - Sao Paulo Grand Prix - fp1 2160p50.mp4
  • fp2: basically the same as fp1
  • fp3: basically the same as fp1
  • quali: The string that identify that your video is a qualification session. E.g.: Formula 1 - s2023e20 - Sao Paulo Grand Prix - qualification 2160p50.mp4
  • sprint: The string that identify that your video is a sprint race. E.g.: Formula 1 - s2023e20 - Sao Paulo Grand Prix - Sprint 2160p50.mp4
  • metadata_extension: The metadata file extension, default .nfo
  • season_metadata: The season metadata file, it is used to check if we need to create this file or not. Default season.nfo.
  • season_episode_format: A regex string to identify the season and episode format, for example, to identify the sub-string s2013e10. You don't have to change this if this is the format of your rounds file name.

Note: The identification strings are case-insensitive, i.e. "FP1" is the same as "fp1".

Requirements

  • Nothing besides the standard python lib
  • Tested with python 12+. Maybe it will run on older versions.

If you want to use --convert-to-jpg, you need to install Pillow:

pip install Pillow

Things that I know that need to be done

  • Add a decent Wikipedia API request.
  • Add support for different languages from Wikipedia.
  • Find a new API since ergast is about to end :(
  • Generate the show metadata tvshow.nfo. As a workaround you can try to ask jellyfin to fetch it.
  • Fetch the season poster. For now, add it manually using one of the posters in the link below, or ask jellyfin to fetch one, it will be the generic F1 one.

References

License

The Source Code in this repository is subject to the terms of the Mozilla Public License, v. 2.0. Check the LICENSE file for more information or at https://mozilla.org/MPL/2.0/