https://github.com/buried-in-code/mediux-posters

https://github.com/buried-in-code/mediux-posters

jellyfin mediux plex posters python-3

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/buried-in-code/mediux-posters
• Owner: Buried-In-Code
• License: mit
• Created: 2024-10-16T03:07:16.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-01-05T10:02:27.000Z (9 months ago)
• Last Synced: 2025-01-20T06:57:01.326Z (9 months ago)
• Topics: jellyfin, mediux, plex, posters, python-3
• Language: Python
• Homepage:
• Size: 230 KB
• Stars: 6
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Mediux Posters

[![PyPI - Python](https://img.shields.io/pypi/pyversions/Mediux-Posters.svg?logo=PyPI&label=Python&style=flat-square)](https://pypi.python.org/pypi/Mediux-Posters/)

[![PyPI - Status](https://img.shields.io/pypi/status/Mediux-Posters.svg?logo=PyPI&label=Status&style=flat-square)](https://pypi.python.org/pypi/Mediux-Posters/)

[![PyPI - Version](https://img.shields.io/pypi/v/Mediux-Posters.svg?logo=PyPI&label=Version&style=flat-square)](https://pypi.python.org/pypi/Mediux-Posters/)

[![PyPI - License](https://img.shields.io/pypi/l/Mediux-Posters.svg?logo=PyPI&label=License&style=flat-square)](https://opensource.org/licenses/MIT)

[![Pre-Commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)

[![Ruff](https://img.shields.io/badge/ruff-enabled-brightgreen?logo=ruff&style=flat-square)](https://github.com/astral-sh/ruff)

[![Github - Contributors](https://img.shields.io/github/contributors/Buried-In-Code/Mediux-Posters.svg?logo=Github&label=Contributors&style=flat-square)](https://github.com/Buried-In-Code/Mediux-Posters/graphs/contributors)

Fetches Show, Movie, and Collection cover art from Mediux and updates Plex/Jellyfin using TMDB IDs.

_Jellyfin Collections are not yet supported._

## Installation

### Pipx

1. Ensure you have [Pipx](https://pipx.pypa.io/stable/) installed: `pipx --version`

2. Install the project: `pipx install Mediux-Posters`

## Usage

Mediux-Posters Commands

  

  ![`uv run Mediux-Posters --help`](docs/img/mediux-posters_commands.svg)

Mediux-Posters sync

  

  ![`uv run Mediux-Posters sync --help`](docs/img/mediux-posters_sync.svg)

Mediux-Posters show

  

  ![`uv run Mediux-Posters show --help`](docs/img/mediux-posters_show.svg)

Mediux-Posters collection

  

  ![`uv run Mediux-Posters collection --help`](docs/img/mediux-posters_collection.svg)

Mediux-Posters movie

  

  ![`uv run Mediux-Posters movie --help`](docs/img/mediux-posters_movie.svg)

Mediux-Posters set

  

  ![`uv run Mediux-Posters set --help`](docs/img/mediux-posters_set.svg)

Mediux-Posters settings

  

  ![`uv run Mediux-Posters settings --help`](docs/img/mediux-posters_settings.svg)

## Notes

- When running a sync/show/collection/movie it will keep downloading sets until all the needed posters are found.

  - **Show:** Poster and Backdrop

  - **Season:** Poster

  - **Episode:** Title Card

  - **Collection:** Poster and Backdrop

  - **Movie:** Poster and Backdrop

- To enable support for Collections in Plex, each Collection needs to have a label with its tmdb-id, in the format of `tmdb-`\

  If using Kometa, refer to [this comment](https://github.com/Buried-In-Code/Mediux-Posters/issues/12#issuecomment-2622002859) to have Kometa add these labels.

## Settings

To set Plex and/or Jellyfin details, update the file: `~/.config/mediux-posters/settings.toml`.

File will be created on first run.

### Example File

```toml

exclude_usernames = []

kometa_integration = false

only_priority_usernames = false

priority_usernames = []

[jellyfin]

base_url = "http://127.0.0.1:8096"

token = ""

[plex]

base_url = "http://127.0.0.1:32400"

token = ""

```

### Details

- `exclude_usernames`

  A list of usernames whose sets should be ignored when running a sync.

- `kometa_integration`

  If enabled, will remove the `Overlay` label from any media Mediux-Posters uploads a poster/backdrop/title-card to.

- `only_priority_usernames`

  A boolean flag that limits downloading sets to ones created by the users specified in `priority_usernames`.

  If set to `false`, all sets will be considered unless explicitly excluded in `exclude_usernames`.

- `priority_usernames`

  A list of usernames whose sets should take priority when running a sync.

  If `only_priority_usernames` is set to `true`, only sets from these users will be used.

## Socials

[![Social - Fosstodon](https://img.shields.io/badge/%40BuriedInCode-teal?label=Fosstodon&logo=mastodon&style=for-the-badge)](https://fosstodon.org/@BuriedInCode)\

[![Social - Matrix](https://img.shields.io/matrix/The-Dev-Environment:matrix.org?label=The-Dev-Environment&logo=matrix&style=for-the-badge)](https://matrix.to/#/#The-Dev-Environment:matrix.org)