Compare commits

...

40 Commits

Author SHA1 Message Date
dependabot[bot]
cd70ab8711 Bump actions/setup-python from 5 to 6
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5 to 6.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-02-13 17:08:28 +00:00
Maximilian Dorninger
51b8794e4d Merge pull request #411 from maxdorninger/Dependabot-auto-bump-deps
Configure Dependabot for multiple package ecosystems
2026-02-13 18:07:54 +01:00
Mark Riabov
0cfd1fa724 Fix suffix formatting for with_suffix call (#408)
Fixes issue ValueError: Invalid suffix 'jpg'

Completely prevents downloading posters from metadata provider
2026-02-10 20:29:05 +01:00
Maximilian Dorninger
b5b297e99a add new sponsor syn (#405)
this PR adds the new sponsor syn
2026-02-08 20:10:06 +01:00
maxid
58414cadae update all links to docs 2026-02-08 19:47:17 +01:00
maxid
462794520e update docs workflow 2026-02-08 19:43:13 +01:00
maxid
59afba007d update docs workflow 2026-02-08 19:36:07 +01:00
Maximilian Dorninger
cfa303e4f3 Merge pull request #404 from maxdorninger/mkdocs
This PR replaces Gitbook with Mkdocs to provide documentation
2026-02-08 19:27:15 +01:00
maxid
d3dde9c7eb add docs workflow 2026-02-08 19:22:34 +01:00
maxid
9c94ef6de0 convert gitbook files to mkdocs 2026-02-08 19:16:38 +01:00
Maximilian Dorninger
2665106847 Merge pull request #401 from maxdorninger/fix-env-variables
Fix download clients config being read from env variables
2026-02-08 16:37:15 +01:00
maxid
d029177fc0 hot fix: fix search tag name for episode in jackett 2026-02-04 23:52:07 +01:00
Maximilian Dorninger
1698c404cd Merge pull request #400 from maxdorninger/add-search-by-id-support-to-jackett
Add search by id support to jackett
2026-02-04 23:00:00 +01:00
maxid
abac894a95 fix download clients config being read from env variables without the mediamanager prefix 2026-02-04 22:49:24 +01:00
maxid
12854ff661 format files 2026-02-04 21:34:37 +01:00
maxid
3d52a87302 add id search capabilities to jackett 2026-02-04 21:34:31 +01:00
Maximilian Dorninger
9ee5cc6895 make the container user configurable (#399)
This PR makes the user the container runs as configurable. Before, the
container always tried stepping down (from root) to the mediamanager
user. Now it detects if it's already running as a non-root user and
starts the server directly. Fixes #397
2026-02-04 19:01:18 +01:00
Maximilian Dorninger
c45c9e5873 add correlation id to logging (#398)
This PR adds Correlation IDs to logs and request responses.

```
2026-02-04 12:40:32,793 - [afd825081d874d6e835b5c59a6ddb371] DEBUG - media_manager.movies - get_importable_movies(): Found 5 importable movies.
2026-02-04 12:40:32,794 - [afd825081d874d6e835b5c59a6ddb371] INFO - uvicorn.access - send(): 172.19.0.1:64094 - "GET /api/v1/movies/importable HTTP/1.1" 200
2026-02-04 12:40:47,322 - [41d30b7003fd45288c6a4bb1cfba5e7a] INFO - uvicorn.access - send(): 127.0.0.1:52964 - "GET /api/v1/health HTTP/1.1" 200
2026-02-04 12:41:17,408 - [157027ea5dde472a9e620f53739ccd53] INFO - uvicorn.access - send(): 127.0.0.1:39850 - "GET /api/v1/health HTTP/1.1" 200
```
2026-02-04 13:55:05 +01:00
Sergey Khruschak
24fcba6bee Torrent file name sanitizing (#390)
Hi, I've added file names sanitization when saving the torrent file, as
previously the import was failing on torrents with special characters in
names. This fixes #367
2026-02-03 17:09:36 +01:00
Maximilian Dorninger
d5994a9037 Fix docker permission issues (#395)
This PR fixes docker permission issues by first starting as root and
then chown-ing all the volumes. This should fix #388 #389
2026-02-03 13:06:18 +01:00
just_Bri
9e0d0c03c0 feat: add links to media detail pages in requests and torrent tables (#352)
Feature Request: https://github.com/maxdorninger/MediaManager/issues/351

[feat: add links to media detail pages in requests and torrent
tables](ac376c0d6d)
2026-02-02 22:48:14 +01:00
Maximilian Dorninger
70ff8f6ace Fix the broken link to the disable ascii art page (#396)
Fix the broken link to the disable ascii art page
2026-02-02 22:22:11 +01:00
Maximilian Dorninger
e347219721 Merge pull request #394 from juandbc/fix-torznab-process-and-jackett-movies-search
Fix torznab process and jackett movies search
2026-02-02 17:42:49 +01:00
strangeglyph
72a626cb1a Add flag to disable startup ascii art (#369)
Adds an environment variable to disable the colorized splash screen.
2026-02-02 17:39:47 +01:00
Juan David Bermudez Celedon
a1f3f92c10 Enhance size validation for indexer results 2026-02-01 22:14:04 -05:00
Juan David Bermudez Celedon
caaa08fbf4 Fix typo in Jackett log for search_movie 2026-02-01 22:01:42 -05:00
Juan David Bermudez Celedon
5db60141bb Fix bug by typo in jackett log message (#387)
fix typo in the `search_season` function log, which causes an error when searching for torrents.
2026-02-01 18:09:18 +01:00
Marcel Hellwig
96b84d45db Adding some more new lints (#393)
Enable `UP` and `TRY` lint
2026-02-01 18:04:15 +01:00
Marcel Hellwig
311e625eee two hotfixes (#392)
this prevents the app from running correctly
2026-02-01 17:42:15 +01:00
maxidorninger
e22e0394bd GITBOOK-19: No subject 2026-01-09 20:13:39 +00:00
maxid
6377aa8b83 rever "add digital ocean attribution" in GitBook 2026-01-09 21:02:19 +01:00
Maximilian Dorninger
8855204930 add digital ocean attribution (#368) 2026-01-09 20:54:47 +01:00
maxidorninger
7a13326d87 GITBOOK-16: No subject 2026-01-07 19:10:20 +00:00
maxidorninger
15e9cd001f GITBOOK-15: No subject 2026-01-07 18:59:43 +00:00
maxidorninger
e52b84c3c7 GITBOOK-14: No subject 2026-01-07 18:58:37 +00:00
maxidorninger
84a430651f GITBOOK-13: No subject 2026-01-07 18:57:25 +00:00
maxidorninger
463e6914e3 GITBOOK-12: No subject 2026-01-07 18:56:20 +00:00
strangeglyph
e5e85077ae docs: add installation instructions for nix flake (#361)
Following the discussion in #329 and #115, here's a doc section on using
nix flakes to install MediaManager.

Co-authored-by: lschuetze <lschuetze@mpi-sws.org>
2026-01-07 19:45:47 +01:00
Maximilian Dorninger
a39e0d204a Ruff enable type annotations rule (#362)
This PR enables the ruff rule for return type annotations (ANN), and
adds the ty package for type checking.
2026-01-06 17:07:19 +01:00
Renan Greca
dd0b439bbe Fix logging bug in jackett indexer (#360)
fix MM trying to access non-existent attribute
2026-01-06 14:49:06 +01:00
133 changed files with 1604 additions and 1038 deletions

View File

@@ -53,5 +53,5 @@ YOUR CONFIG HERE
```
- [ ] I understand, that without logs and/or screenshots and a detailed description of the problem, it is very hard to fix bugs.
- [ ] I have checked the [documentation](https://maximilian-dorninger.gitbook.io/mediamanager) for help.
- [ ] I have checked the [documentation](https://maxdorninger.github.io/MediaManager/) for help.
- [ ] I have searched the [issues](https://github.com/maxdorninger/MediaManager/issues) for similar issues and found none.

25
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,25 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
open-pull-requests-limit: 5
- package-ecosystem: "npm"
directory: "/web"
schedule:
interval: "weekly"
open-pull-requests-limit: 5
- package-ecosystem: "uv"
directory: "/"
schedule:
interval: "weekly"
open-pull-requests-limit: 5

62
.github/workflows/docs.yml vendored Normal file
View File

@@ -0,0 +1,62 @@
name: Publish docs via GitHub Pages
on:
push:
branches:
- master
tags:
- v*
workflow_dispatch:
inputs:
set_default_alias:
description: 'Alias to set as default (e.g. latest, master)'
required: false
default: 'latest'
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v6
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Install dependencies
run: pip install mkdocs-material mike
- name: Deploy (master)
if: github.ref == 'refs/heads/master'
run: |
mike deploy --push --update-aliases master
- name: Deploy (tag)
if: startsWith(github.ref, 'refs/tags/v')
run: |
version=${GITHUB_REF#refs/tags/}
mike deploy --push --update-aliases $version latest --title "$version"
mike set-default --push latest
- name: Set Default (Manual)
if: github.event_name == 'workflow_dispatch' && github.event.inputs.set_default_alias != ''
run: |
mike set-default --push ${{ github.event.inputs.set_default_alias }}

4
.gitignore vendored
View File

@@ -49,5 +49,5 @@ __pycache__
# Postgres
/postgres
# Node modules
/node_modules/*
# MkDocs
site/

View File

@@ -18,7 +18,7 @@ Generally, if you have any questions or need help on the implementation side of
just ask in the issue, or in a draft PR.
Also, see the contribution guide in the docs for information on how to setup the dev environment:
https://maximilian-dorninger.gitbook.io/mediamanager
https://maxdorninger.github.io/MediaManager/
### For something that is a one or two line fix:

View File

@@ -13,7 +13,7 @@ RUN env PUBLIC_VERSION=${VERSION} PUBLIC_API_URL=${BASE_PATH} BASE_PATH=${BASE_P
FROM ghcr.io/astral-sh/uv:python3.13-trixie-slim AS base
RUN apt-get update && \
apt-get install -y ca-certificates bash libtorrent21 gcc bc locales postgresql media-types mailcap curl gzip unzip tar 7zip bzip2 unar && \
apt-get install -y ca-certificates bash libtorrent21 gcc bc locales postgresql media-types mailcap curl gzip unzip tar 7zip bzip2 unar gosu && \
apt-get clean && \
rm -rf /var/lib/apt/lists/*
@@ -33,7 +33,6 @@ RUN chown -R mediamanager:mediamanager /app
USER mediamanager
# Set uv cache to a writable home directory and use copy mode for volume compatibility
ENV UV_CACHE_DIR=/home/mediamanager/.cache/uv \
UV_LINK_MODE=copy
@@ -47,6 +46,7 @@ ARG BASE_PATH=""
LABEL author="github.com/maxdorninger"
LABEL version=${VERSION}
LABEL description="Docker image for MediaManager"
USER root
ENV PUBLIC_VERSION=${VERSION} \
CONFIG_DIR="/app/config" \

View File

@@ -1,7 +1,7 @@
<br />
<div align="center">
<a href="https://maximilian-dorninger.gitbook.io/mediamanager">
<img src="https://github.com/maxdorninger/MediaManager/blob/master/web/static/logo.svg" alt="Logo" width="260" height="260">
<a href="https://maxdorninger.github.io/MediaManager/">
<img src="https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/web/static/logo.svg" alt="Logo" width="260" height="260">
</a>
<h3 align="center">MediaManager</h3>
@@ -9,7 +9,7 @@
<p align="center">
Modern management system for your media library
<br />
<a href="https://maximilian-dorninger.gitbook.io/mediamanager"><strong>Explore the docs »</strong></a>
<a href="https://maxdorninger.github.io/MediaManager/"><strong>Explore the docs »</strong></a>
<br />
<a href="https://github.com/maxdorninger/MediaManager/issues/new?labels=bug&template=bug_report.md">Report Bug</a>
&middot;
@@ -35,7 +35,7 @@ wget -O ./config/config.toml https://github.com/maxdorninger/MediaManager/releas
docker compose up -d
```
### [View the docs for installation instructions and more](https://maximilian-dorninger.gitbook.io/mediamanager)
### [View the docs for installation instructions and more](https://maxdorninger.github.io/MediaManager/)
## Support MediaManager
@@ -60,6 +60,7 @@ docker compose up -d
<a href="https://buymeacoffee.com/maxdorninger"><img src="https://cdn.buymeacoffee.com/uploads/profile_pictures/default/v2/DEBBB9/JO.png" width="80px" alt="Josh" /></a>&nbsp;&nbsp;
<a href="https://buymeacoffee.com/maxdorninger"><img src="https://cdn.buymeacoffee.com/uploads/profile_pictures/2025/11/2VeQ8sTGPhj4tiLy.jpg" width="80px" alt="PuppiestDoggo" /></a>&nbsp;&nbsp;
<a href="https://github.com/seferino-fernandez"><img src="https://avatars.githubusercontent.com/u/5546622" width="80px" alt="Seferino" /></a>&nbsp;&nbsp;
<a href="https://buymeacoffee.com/maxdorninger"><img src="https://cdn.buymeacoffee.com/uploads/profile_pictures/default/v2/EC9689/SY.png" width="80px" alt="syn" /></a>&nbsp;&nbsp;
## Star History
@@ -80,7 +81,7 @@ docker compose up -d
## Developer Quick Start
For the developer guide see the [Developer Guide](https://maximilian-dorninger.gitbook.io/mediamanager).
For the developer guide see the [Developer Guide](https://maxdorninger.github.io/MediaManager/).
<!-- LICENSE -->
@@ -93,5 +94,9 @@ Distributed under the AGPL 3.0. See `LICENSE.txt` for more information.
## Acknowledgments
Thanks to DigitalOcean for sponsoring the project!
[![DigitalOcean Referral Badge](https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%201.svg)](https://www.digitalocean.com/?refcode=4edf05429dca&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)
* [Thanks to Pawel Czerwinski for the image on the login screen](https://unsplash.com/@pawel_czerwinski)

View File

@@ -106,7 +106,13 @@ def run_migrations_online() -> None:
"""
def include_object(_object, name, type_, _reflected, _compare_to):
def include_object(
_object: object | None,
name: str | None,
type_: str | None,
_reflected: bool | None,
_compare_to: object | None,
) -> bool:
if type_ == "table" and name == "apscheduler_jobs":
return False
return True

View File

@@ -1,6 +1,6 @@
# MediaManager Dev Configuration File
# This file contains all available configuration options for MediaManager
# Documentation: https://maximilian-dorninger.gitbook.io/mediamanager
# Documentation: https://maxdorninger.github.io/MediaManager/
#
# This is an example configuration file that gets copied to your config folder
# on first boot. You should modify the values below to match your setup.

View File

@@ -1,6 +1,6 @@
# MediaManager Example Configuration File
# This file contains all available configuration options for MediaManager
# Documentation: https://maximilian-dorninger.gitbook.io/mediamanager
# Documentation: https://maxdorninger.github.io/MediaManager/
#
# This is an example configuration file that gets copied to your config folder
# on first boot. You should modify the values below to match your setup.

View File

@@ -56,6 +56,15 @@ services:
- ./web:/app
depends_on:
- mediamanager
docs:
image: squidfunk/mkdocs-material:9
container_name: mediamanager-docs
volumes:
- .:/docs
ports:
- "9000:9000"
command: serve -w /docs -a 0.0.0.0:9000
# ----------------------------
# Additional services can be uncommented and configured as needed
@@ -130,17 +139,17 @@ services:
# ports:
# - 8081:8080
# restart: unless-stopped
# jackett:
# image: lscr.io/linuxserver/jackett:latest
# container_name: jackett
# environment:
# - PUID=1000
# - PGID=1000
# - TZ=Etc/UTC
# - AUTO_UPDATE=true
# volumes:
# - ./res/jackett/data:/config
# - ./res/jackett/torrents:/downloads
# ports:
# - 9117:9117
# restart: unless-stopped
jackett:
image: lscr.io/linuxserver/jackett:latest
container_name: jackett
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- AUTO_UPDATE=true
volumes:
- ./res/jackett/data:/config
- ./res/jackett/torrents:/downloads
ports:
- 9117:9117
restart: unless-stopped

View File

@@ -1,38 +0,0 @@
---
layout:
width: wide
title:
visible: true
description:
visible: true
tableOfContents:
visible: true
outline:
visible: false
pagination:
visible: true
metadata:
visible: true
---
# MediaManager
MediaManager is the modern, easy-to-use successor to the fragmented "Arr" stack. Manage, discover, and automate your TV and movie collection in a single, simple interface.
_Replaces Sonarr, Radarr, Seerr, and more._
### Quick Links
<table data-view="cards" data-full-width="true"><thead><tr><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center">Installation Guide</td><td><a href="installation-guide.md">installation-guide.md</a></td></tr><tr><td align="center">Configuration</td><td><a href="configuration/">configuration</a></td></tr><tr><td align="center">Developer Guide</td><td><a href="developer-guide.md">developer-guide.md</a></td></tr><tr><td align="center">Troubleshooting</td><td><a href="troubleshooting.md">troubleshooting.md</a></td></tr><tr><td align="center">Advanced Features</td><td><a href="advanced-features/">advanced-features</a></td></tr><tr><td align="center">Import Existing Media</td><td><a href="importing-existing-media.md">importing-existing-media.md</a></td></tr></tbody></table>
## Support MediaManager & Maximilian Dorninger
<table data-card-size="large" data-view="cards" data-full-width="true"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td>Sponsor me on GitHub Sponsors :)</td><td><a href="https://github.com/sponsors/maxdorninger">https://github.com/sponsors/maxdorninger</a></td><td></td></tr><tr><td>Buy me a coffee :)</td><td><a href="https://buymeacoffee.com/maxdorninger">https://buymeacoffee.com/maxdorninger</a></td><td></td></tr></tbody></table>
### MediaManager Sponsors
<table data-view="cards" data-full-width="true"><thead><tr><th>Sponsor</th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td>Aljaž Mur Eržen</td><td><a href="https://fosstodon.org/@aljazmerzen">https://fosstodon.org/@aljazmerzen</a></td><td><a href="https://github.com/aljazerzen.png">https://github.com/aljazerzen.png</a></td></tr><tr><td>Luis Rodriguez</td><td><a href="https://github.com/ldrrp">https://github.com/ldrrp</a></td><td><a href="https://github.com/ldrrp.png">https://github.com/ldrrp.png</a></td></tr><tr><td>Brandon P.</td><td><a href="https://github.com/brandon-dacrib">https://github.com/brandon-dacrib</a></td><td><a href="https://github.com/brandon-dacrib.png">https://github.com/brandon-dacrib.png</a></td></tr><tr><td>SeimusS</td><td><a href="https://github.com/SeimusS">https://github.com/SeimusS</a></td><td><a href="https://github.com/SeimusS.png">https://github.com/SeimusS.png</a></td></tr><tr><td>HadrienKerlero</td><td><a href="https://github.com/HadrienKerlero">https://github.com/HadrienKerlero</a></td><td><a href="https://github.com/HadrienKerlero.png">https://github.com/HadrienKerlero.png</a></td></tr><tr><td>keyxmakerx</td><td><a href="https://github.com/keyxmakerx">https://github.com/keyxmakerx</a></td><td><a href="https://github.com/keyxmakerx.png">https://github.com/keyxmakerx.png</a></td></tr><tr><td>LITUATUI</td><td><a href="https://github.com/LITUATUI">https://github.com/LITUATUI</a></td><td><a href="https://github.com/LITUATUI.png">https://github.com/LITUATUI.png</a></td></tr><tr><td>Nicolas</td><td><a href="https://buymeacoffee.com/maxdorninger">https://buymeacoffee.com/maxdorninger</a></td><td><a href="https://cdn.buymeacoffee.com/uploads/profile_pictures/default/v2/B6CDBD/NI.png">https://cdn.buymeacoffee.com/uploads/profile_pictures/default/v2/B6CDBD/NI.png</a></td></tr><tr><td>Josh</td><td><a href="https://buymeacoffee.com/maxdorninger">https://buymeacoffee.com/maxdorninger</a></td><td><a href="https://cdn.buymeacoffee.com/uploads/profile_pictures/default/v2/DEBBB9/JO.png">https://cdn.buymeacoffee.com/uploads/profile_pictures/default/v2/DEBBB9/JO.png</a></td></tr><tr><td>PuppiestDoggo</td><td><a href="https://buymeacoffee.com/maxdorninger">https://buymeacoffee.com/maxdorninger</a></td><td><a href="https://cdn.buymeacoffee.com/uploads/profile_pictures/2025/11/2VeQ8sTGPhj4tiLy.jpg">https://cdn.buymeacoffee.com/uploads/profile_pictures/2025/11/2VeQ8sTGPhj4tiLy.jpg</a></td></tr><tr><td>Seferino</td><td><a href="https://github.com/seferino-fernandez">https://github.com/seferino-fernandez</a></td><td><a href="https://avatars.githubusercontent.com/u/5546622">https://avatars.githubusercontent.com/u/5546622</a></td></tr></tbody></table>
### MediaManager Repository
https://github.com/maxdorninger/MediaManager

View File

@@ -1,26 +0,0 @@
# Table of contents
* [MediaManager](README.md)
* [Installation Guide](installation-guide.md)
* [Importing existing media](importing-existing-media.md)
* [Usage](usage.md)
* [Configuration](configuration/README.md)
* [Backend](configuration/backend.md)
* [Authentication](configuration/authentication.md)
* [Database](configuration/database.md)
* [Download Clients](configuration/download-clients.md)
* [Indexers](configuration/indexers.md)
* [Scoring Rulesets](configuration/scoring-rulesets.md)
* [Notifications](configuration/notifications.md)
* [Custom Libraries](configuration/custom-libraries.md)
* [Logging](configuration/logging.md)
* [Advanced Features](advanced-features/README.md)
* [qBittorrent Category](advanced-features/qbittorrent-category.md)
* [URL Prefix](advanced-features/url-prefix.md)
* [Metadata Provider Configuration](advanced-features/metadata-provider-configuration.md)
* [Custom port](advanced-features/custom-port.md)
* [Follow symlinks in frontend files](advanced-features/follow-symlinks-in-frontend-files.md)
* [Troubleshooting](troubleshooting.md)
* [Developer Guide](developer-guide.md)
* [API Reference](api-reference.md)
* [Screenshots](screenshots.md)

View File

@@ -1,9 +0,0 @@
---
description: >-
The features in this section are not required to run MediaManager and serve
their purpose in very specific environments, but they can enhance your
experience and provide additional functionality.
---
# Advanced Features

View File

@@ -0,0 +1,4 @@
# Disable Startup Ascii Art
* `MEDIAMANAGER_NO_STARTUP_ART`: Set this environment variable (to any value) \
to disable the colorized startup splash screen. Unset to reenable.

View File

@@ -7,8 +7,6 @@ MediaManager can be configured to follow symlinks when serving frontend files. T
* `FRONTEND_FOLLOW_SYMLINKS`\
Set this environment variable to `true` to follow symlinks when serving frontend files. Default is `false`.
{% code title=".env" %}
```bash
```bash title=".env"
FRONTEND_FOLLOW_SYMLINKS=true
```
{% endcode %}

View File

@@ -8,9 +8,8 @@ Metadata provider settings are configured in the `[metadata]` section of your `c
TMDB (The Movie Database) is the primary metadata provider for MediaManager. It provides detailed information about movies and TV shows.
{% hint style="info" %}
Other software like Jellyfin use TMDB as well, so there won't be any metadata discrepancies.
{% endhint %}
!!! info
Other software like Jellyfin use TMDB as well, so there won't be any metadata discrepancies.
* `tmdb_relay_url`\
URL of the TMDB relay (MetadataRelay). Default is `https://metadata-relay.dorninger.co/tmdb`. Example: `https://your-own-relay.example.com/tmdb`.
@@ -19,24 +18,21 @@ Other software like Jellyfin use TMDB as well, so there won't be any metadata di
* `default_language`\
TMDB language parameter used when searching and adding. Default is `en`. Format: ISO 639-1 (2 letters).
{% hint style="warning" %}
`default_language` sets the TMDB `language` parameter when searching and adding TV shows and movies. If TMDB does not find a matching translation, metadata in the original language will be fetched with no option for a fallback language. It is therefore highly advised to only use "broad" languages. For most use cases, the default setting is safest.
{% endhint %}
!!! warning
`default_language` sets the TMDB `language` parameter when searching and adding TV shows and movies. If TMDB does not find a matching translation, metadata in the original language will be fetched with no option for a fallback language. It is therefore highly advised to only use "broad" languages. For most use cases, the default setting is safest.
### TVDB Settings (`[metadata.tvdb]`)
{% hint style="warning" %}
The TVDB might provide false metadata and doesn't support some features of MediaManager like showing overviews. Therefore, TMDB is the preferred metadata provider.
{% endhint %}
!!! warning
The TVDB might provide false metadata and doesn't support some features of MediaManager like showing overviews. Therefore, TMDB is the preferred metadata provider.
* `tvdb_relay_url`\
URL of the TVDB relay (MetadataRelay). Default is `https://metadata-relay.dorninger.co/tvdb`. Example: `https://your-own-relay.example.com/tvdb`.
### MetadataRelay
{% hint style="info" %}
To use MediaManager you don't need to set up your own MetadataRelay, as the default relay hosted by the developer should be sufficient for most purposes.
{% endhint %}
!!! info
To use MediaManager you don't need to set up your own MetadataRelay, as the default relay hosted by the developer should be sufficient for most purposes.
The MetadataRelay is a service that provides metadata for MediaManager. It acts as a proxy for TMDB and TVDB, allowing you to use your own API keys if needed, but the default relay means you don't need to create accounts for API keys yourself.
@@ -47,16 +43,14 @@ You might want to use your own relay if you want to avoid rate limits, protect y
* Get a TMDB API key from [The Movie Database](https://www.themoviedb.org/settings/api)
* Get a TVDB API key from [The TVDB](https://thetvdb.com/auth/register)
{% hint style="info" %}
If you want to use your own MetadataRelay, you can set the `tmdb_relay_url` and/or `tvdb_relay_url` to your own relay service.
{% endhint %}
!!! info
If you want to use your own MetadataRelay, you can set the `tmdb_relay_url` and/or `tvdb_relay_url` to your own relay service.
### Example Configuration
Here's a complete example of the metadata section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[metadata]
# TMDB configuration
[metadata.tmdb]
@@ -66,8 +60,6 @@ Here's a complete example of the metadata section in your `config.toml`:
[metadata.tvdb]
tvdb_relay_url = "https://metadata-relay.dorninger.co/tvdb"
```
{% endcode %}
{% hint style="info" %}
In most cases, you can simply use the default values and don't need to specify these settings in your config file at all.
{% endhint %}
!!! info
In most cases, you can simply use the default values and don't need to specify these settings in your config file at all.

View File

@@ -9,10 +9,8 @@ Use the following variables to customize behavior:
* `torrents.qbittorrent.category_save_path`\
Save path for the category in qBittorrent. By default, no subdirectory is used. Example: `/data/torrents/MediaManager`.
{% hint style="info" %}
qBittorrent saves torrents to the path specified by `torrents.qbittorrent.category_save_path`, so it must be a valid path that qBittorrent can write to.
{% endhint %}
!!! info
qBittorrent saves torrents to the path specified by `torrents.qbittorrent.category_save_path`, so it must be a valid path that qBittorrent can write to.
{% hint style="warning" %}
For MediaManager to successfully import torrents, you must add the subdirectory to the `misc.torrent_directory` variable.
{% endhint %}
!!! warning
For MediaManager to successfully import torrents, you must add the subdirectory to the `misc.torrent_directory` variable.

View File

@@ -6,23 +6,20 @@ In order to run it on a prefixed path, like `maxdorninger.github.io/media`, the
In short, clone the repository, then run:
{% code title="Build Docker image" %}
```none
```none title="Build Docker image"
docker build \
--build-arg BASE_PATH=/media \
--build-arg VERSION=my-custom-version \
-t MediaManager:my-custom-version \
-f Dockerfile .
```
{% endcode %}
You also need to set the `BASE_PATH` environment variable at runtime in `docker-compose.yaml`:
* `BASE_PATH`\
Base path prefix MediaManager is served under. Example: `/media`. This must match the `BASE_PATH` build arg.
{% code title="docker-compose.yaml (excerpt)" %}
```yaml
```yaml title="docker-compose.yaml (excerpt)"
services:
mediamanager:
image: MediaManager:my-custom-version
@@ -32,10 +29,8 @@ services:
BASE_PATH: /media
...
```
{% endcode %}
{% hint style="info" %}
Make sure to include the base path in the `frontend_url` field in the config file. See [Backend](../configuration/backend.md).
{% endhint %}
!!! info
Make sure to include the base path in the `frontend_url` field in the config file. See [Backend](../configuration/backend.md).
Finally, ensure that whatever reverse proxy you're using leaves the incoming path unchanged; that is, you should not strip the `/media` from `/media/web/`.

View File

@@ -1,8 +1,7 @@
# API Reference
{% hint style="info" %}
Media Manager's backend is built with FastAPI, which automatically generates interactive API documentation.
{% endhint %}
!!! info
Media Manager's backend is built with FastAPI, which automatically generates interactive API documentation.
* Swagger UI (typically available at `http://localhost:8000/docs`)
* ReDoc (typically available at `http://localhost:8000/redoc`)

View File

Before

Width:  |  Height:  |  Size: 3.1 MiB

After

Width:  |  Height:  |  Size: 3.1 MiB

View File

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

Before

Width:  |  Height:  |  Size: 9.0 KiB

After

Width:  |  Height:  |  Size: 9.0 KiB

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 244 KiB

After

Width:  |  Height:  |  Size: 244 KiB

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 113 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

View File

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 8.9 MiB

After

Width:  |  Height:  |  Size: 8.9 MiB

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 5.5 MiB

After

Width:  |  Height:  |  Size: 5.5 MiB

View File

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 7.6 MiB

After

Width:  |  Height:  |  Size: 7.6 MiB

View File

Before

Width:  |  Height:  |  Size: 123 KiB

After

Width:  |  Height:  |  Size: 123 KiB

158
docs/assets/logo.svg Normal file
View File

@@ -0,0 +1,158 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:svg="http://www.w3.org/2000/svg"
version="1.1"
id="svg1"
width="2000"
height="2000"
viewBox="0 0 2000 2000"
sodipodi:docname="logo2.svg"
inkscape:version="1.4.2 (f4327f4, 2025-05-13)"
xmlns="http://www.w3.org/2000/svg">
<defs
id="defs1">
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath1">
<path
d="M 0,1500 H 1500 V 0 H 0 Z"
id="path1"/>
</clipPath>
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath3">
<path
d="M 0,0 H 1500 V 1500 H 0 Z"
transform="matrix(1.3333333,0,0,-1.3333333,0,2000)"
id="path3"/>
</clipPath>
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath4">
<path
d="M -17.6886,1032.99 H 1106.27 V 238.53 H -17.6886 Z"
transform="translate(-319.61281,-1032.9941)"
id="path4"/>
</clipPath>
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath6">
<path
d="M 0,0 H 1500 V 1500 H 0 Z"
transform="matrix(1.3333333,0,0,-1.3333333,0,2000)"
id="path6"/>
</clipPath>
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath7">
<path
d="M 223.314,1226.85 H 1182.49 V 548.867 H 223.314 Z"
transform="translate(-894.64255,-548.86681)"
id="path7"/>
</clipPath>
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath9">
<path
d="M 0,0 H 1500 V 1500 H 0 Z"
transform="matrix(1.3333333,0,0,-1.3333333,0,2000)"
id="path9"/>
</clipPath>
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath10">
<path
d="M 301.561,1098.17 H 1517.73 V 238.53 H 301.561 Z"
transform="translate(-666.53282,-1098.1678)"
id="path10"/>
</clipPath>
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath12">
<path
d="M 0,0 H 1500 V 1500 H 0 Z"
transform="matrix(1.3333333,0,0,-1.3333333,0,2000)"
id="path12"/>
</clipPath>
</defs>
<sodipodi:namedview
id="namedview1"
pagecolor="#ffffff"
bordercolor="#000000"
borderopacity="0.25"
inkscape:showpageshadow="2"
inkscape:pageopacity="0.0"
inkscape:pagecheckerboard="0"
inkscape:deskcolor="#d1d1d1"
inkscape:zoom="0.9075"
inkscape:cx="999.44904"
inkscape:cy="1000"
inkscape:window-width="3840"
inkscape:window-height="2054"
inkscape:window-x="3373"
inkscape:window-y="199"
inkscape:window-maximized="1"
inkscape:current-layer="g1">
<inkscape:page
x="0"
y="0"
inkscape:label="1"
id="page1"
width="2000"
height="2000"
margin="0"
bleed="0"/>
</sodipodi:namedview>
<g
id="g1"
inkscape:groupmode="layer"
inkscape:label="1">
<g
id="g2"
clip-path="url(#clipPath3)">
<path
d="M 0,0 H 1500 V 1500 H 0 Z"
style="fill:#9ed8f7;fill-opacity:0;fill-rule:nonzero;stroke:none"
transform="matrix(1.3333333,0,0,-1.3333333,0,2000)"
clip-path="url(#clipPath1)"
id="path2"/>
</g>
<g
opacity="0.720001"
id="g5"
clip-path="url(#clipPath6)">
<path
d="m 0,0 h 669.787 c 68.994,0 116.873,-68.746 92.95,-133.46 L 542.309,-729.728 c -14.382,-38.904 -51.472,-64.736 -92.95,-64.736 h -669.787 c -68.994,0 -116.873,68.746 -92.949,133.46 L -92.949,-64.736 C -78.567,-25.832 -41.478,0 0,0"
style="fill:#2842fc;fill-opacity:1;fill-rule:nonzero;stroke:none"
transform="matrix(1.3333333,0,0,-1.3333333,426.1504,622.67453)"
clip-path="url(#clipPath4)"
id="path5"/>
</g>
<g
opacity="0.720001"
id="g8"
clip-path="url(#clipPath9)">
<path
d="m 0,0 h -571.59 c -58.879,0 -99.738,58.667 -79.322,113.893 l 188.111,508.849 c 12.274,33.201 43.925,55.246 79.322,55.246 h 571.59 c 58.879,0 99.739,-58.667 79.322,-113.894 L 79.322,55.245 C 67.049,22.045 35.397,0 0,0"
style="fill:#ff5e00;fill-opacity:1;fill-rule:nonzero;stroke:none"
transform="matrix(1.3333333,0,0,-1.3333333,1192.8567,1268.1776)"
clip-path="url(#clipPath7)"
id="path8"/>
</g>
<g
opacity="0.75"
id="g11"
clip-path="url(#clipPath12)">
<path
d="m 0,0 h 724.733 c 74.654,0 126.46,-74.386 100.575,-144.408 L 586.797,-789.591 c -15.562,-42.096 -55.694,-70.047 -100.575,-70.047 h -724.733 c -74.654,0 -126.461,74.386 -100.574,144.409 l 238.511,645.182 C -85.013,-27.952 -44.88,0 0,0"
style="fill:#f20a4c;fill-opacity:1;fill-rule:nonzero;stroke:none"
transform="matrix(1.3333333,0,0,-1.3333333,888.7104,535.77627)"
clip-path="url(#clipPath10)"
id="path11"/>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 6.1 KiB

View File

@@ -6,9 +6,8 @@ Frontend settings are configured through environment variables in your `docker-c
## Configuration File Location
{% hint style="warning" %}
Note that MediaManager may need to be restarted for changes in the config file to take effect.
{% endhint %}
!!! warning
Note that MediaManager may need to be restarted for changes in the config file to take effect.
Your `config.toml` file should be in the directory that's mounted to `/app/config/config.toml` inside the container:
@@ -66,6 +65,5 @@ MEDIAMANAGER_AUTH__OPENID_CONNECT__CLIENT_SECRET = "your_client_secret_from_prov
So for every config "level", you basically have to take the name of the value and prepend it with the section names in uppercase with 2 underscores as delimiters and `MEDIAMANAGER_` as the prefix.
{% hint style="warning" %}
Note that not every env variable starts with `MEDIAMANAGER_`; this prefix only applies to env variables which replace/overwrite values in the config file. Variables like the `CONFIG_DIR` env variable must not be prefixed.
{% endhint %}
!!! warning
Note that not every env variable starts with `MEDIAMANAGER_`; this prefix only applies to env variables which replace/overwrite values in the config file. Variables like the `CONFIG_DIR` env variable must not be prefixed.

View File

@@ -20,13 +20,11 @@ All authentication settings are configured in the `[auth]` section of your `conf
* `email_password_resets`\
Enables password resets via email. Default is `false`.
{% hint style="info" %}
To use email password resets, you must also configure SMTP settings in the `[notifications.smtp_config]` section.
{% endhint %}
!!! info
To use email password resets, you must also configure SMTP settings in the `[notifications.smtp_config]` section.
{% hint style="info" %}
When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media and settings.
{% endhint %}
!!! info
When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media and settings.
## OpenID Connect Settings (`[auth.openid_connect]`)
@@ -53,22 +51,20 @@ The OpenID server will likely require a redirect URI. This URL will usually look
{MEDIAMANAGER_URL}/api/v1/auth/oauth/callback
```
{% hint style="warning" %}
It is very important that you set the correct callback URI, otherwise it won't work!
{% endhint %}
!!! warning
It is very important that you set the correct callback URI, otherwise it won't work!
#### Authentik Example
Here is an example configuration for the OpenID Connect provider for Authentik.
![authentik-redirect-url-example](<../.gitbook/assets/authentik redirect url example.png>)
![authentik-redirect-url-example](<../assets/assets/authentik redirect url example.png>)
## Example Configuration
Here's a complete example of the authentication section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[auth]
token_secret = "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6"
session_lifetime = 604800 # 1 week
@@ -82,4 +78,4 @@ client_secret = "your-secret-key-here"
configuration_endpoint = "https://auth.example.com/.well-known/openid-configuration"
name = "Authentik"
```
{% endcode %}

View File

@@ -26,8 +26,7 @@ description: >-
Here's a complete example of the general settings section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[misc]
# REQUIRED: Change this to match your actual frontend domain.
@@ -38,8 +37,6 @@ cors_urls = ["http://localhost:8000"]
# Optional: Development mode (set to true for debugging)
development = false
```
{% endcode %}
{% hint style="info" %}
The `frontend_url` is the most important setting to configure correctly. Make sure it matches your actual deployment URLs.
{% endhint %}
!!! info
The `frontend_url` is the most important setting to configure correctly. Make sure it matches your actual deployment URLs.

View File

@@ -6,9 +6,8 @@ MediaManager supports custom libraries, allowing you to add multiple folders for
Custom libraries are configured in the `misc` section in the `config.toml` file. You can add as many libraries as you need.
{% hint style="info" %}
You are not limited to `/data/tv` or `/data/movies`, you can choose the entire path freely!
{% endhint %}
!!! info
You are not limited to `/data/tv` or `/data/movies`, you can choose the entire path freely!
### Movie Libraries

View File

@@ -19,8 +19,7 @@ Database settings are configured in the `[database]` section of your `config.tom
Here's a complete example of the database section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[database]
host = "db"
port = 5432
@@ -28,8 +27,6 @@ user = "MediaManager"
password = "your_secure_password"
dbname = "MediaManager"
```
{% endcode %}
{% hint style="info" %}
In docker-compose deployments the container name is simultaneously its hostname, so you can use "db" or "postgres" as host.
{% endhint %}
!!! info
In docker-compose deployments the container name is simultaneously its hostname, so you can use "db" or "postgres" as host.

View File

@@ -19,9 +19,8 @@ qBittorrent is a popular BitTorrent client that MediaManager can integrate with
## Transmission Settings (`[torrents.transmission]`)
{% hint style="info" %}
The downloads path in Transmission and MediaManager must be the same, i.e. the path `/data/torrents` must link to the same volume for both containers.
{% endhint %}
!!! info
The downloads path in Transmission and MediaManager must be the same, i.e. the path `/data/torrents` must link to the same volume for both containers.
Transmission is a BitTorrent client that MediaManager can integrate with for downloading torrents.
@@ -59,8 +58,7 @@ SABnzbd is a Usenet newsreader that MediaManager can integrate with for download
Here's a complete example of the download clients section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[torrents]
# qBittorrent configuration
[torrents.qbittorrent]
@@ -87,14 +85,12 @@ Here's a complete example of the download clients section in your `config.toml`:
port = 8080
api_key = "your_sabnzbd_api_key"
```
{% endcode %}
## Docker Compose Integration
When using Docker Compose, make sure your download clients are accessible from the MediaManager backend:
{% code title="docker-compose.yml" %}
```yaml
```yaml title="docker-compose.yml"
services:
# MediaManager backend
backend:
@@ -121,12 +117,9 @@ services:
- ./data/usenet:/downloads
# ... other configuration ...
```
{% endcode %}
{% hint style="warning" %}
You should enable only one BitTorrent and only one Usenet Download Client at any time.
{% endhint %}
!!! warning
You should enable only one BitTorrent and only one Usenet Download Client at any time.
{% hint style="info" %}
Make sure the download directories in your download clients are accessible to MediaManager for proper file management and organization.
{% endhint %}
!!! info
Make sure the download directories in your download clients are accessible to MediaManager for proper file management and organization.

View File

@@ -13,9 +13,8 @@ Indexer settings are configured in the `[indexers]` section of your `config.toml
* `timeout_seconds`\
Timeout in seconds for requests to Prowlarr. Default is `60`.
{% hint style="warning" %}
Symptoms of timeouts are typically no search results ("No torrents found!") in conjunction with logs showing read timeouts.
{% endhint %}
!!! warning
Symptoms of timeouts are typically no search results ("No torrents found!") in conjunction with logs showing read timeouts.
<details>
@@ -50,8 +49,7 @@ DEBUG - media_manager.indexer.utils -
## Example Configuration
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[indexers]
[indexers.prowlarr]
enabled = true
@@ -66,4 +64,4 @@ api_key = "your_jackett_api_key"
indexers = ["1337x", "rarbg"]
timeout_seconds = 60
```
{% endcode %}

View File

@@ -57,8 +57,7 @@ Controls which emails receive notifications.
Here's a complete example of the notifications section in your `config.toml`:
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[notifications]
# SMTP settings for email notifications and password resets
[notifications.smtp_config]
@@ -91,8 +90,7 @@ Here's a complete example of the notifications section in your `config.toml`:
api_key = "your_pushover_api_key"
user = "your_pushover_user_key"
```
{% endcode %}
{% hint style="info" %}
You can enable multiple notification methods simultaneously. For example, you could have both email and Gotify notifications enabled at the same time.
{% endhint %}
!!! info
You can enable multiple notification methods simultaneously. For example, you could have both email and Gotify notifications enabled at the same time.

View File

@@ -17,9 +17,8 @@ Rules define how MediaManager scores releases based on their titles or indexer f
* Reject releases that do not meet certain criteria (e.g., non-freeleech releases).
* and more.
{% hint style="info" %}
The keywords and flags are compared case-insensitively.
{% endhint %}
!!! info
The keywords and flags are compared case-insensitively.
### Title Rules
@@ -38,8 +37,7 @@ Each title rule consists of:
Examples for Title Rules
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[[indexers.title_scoring_rules]]
name = "prefer_h265"
keywords = ["h265", "hevc", "x265"]
@@ -52,7 +50,6 @@ keywords = ["cam", "ts"]
score_modifier = -10000
negate = false
```
{% endcode %}
* The first rule increases the score for releases containing "h265", "hevc", or "x265".
* The second rule heavily penalizes releases containing "cam" or "ts".
@@ -76,8 +73,7 @@ Each indexer flag rule consists of:
Examples for Indexer Flag Rules
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[[indexers.indexer_flag_scoring_rules]]
name = "reject_non_freeleech"
flags = ["freeleech", "freeleech75"]
@@ -90,7 +86,6 @@ flags = ["nuked"]
score_modifier = -10000
negate = false
```
{% endcode %}
* The first rule penalizes releases that do not have the "freeleech" or "freeleech75" flag.
* The second rule penalizes releases that are marked as "nuked".
@@ -99,8 +94,7 @@ If `negate` is set to `true`, the `score_modifier` is applied only if none of th
## Example
{% code title="config.toml" %}
```toml
```toml title="config.toml"
[[indexers.scoring_rule_sets]]
name = "default"
libraries = ["ALL_TV", "ALL_MOVIES"]
@@ -111,7 +105,6 @@ name = "strict_quality"
libraries = ["ALL_MOVIES"]
rule_names = ["prefer_h265", "avoid_cam", "reject_non_freeleech"]
```
{% endcode %}
## Libraries
@@ -127,9 +120,8 @@ You can use special library names in your rulesets:
This allows you to set global rules for all TV or movie content, or provide fallback rules for uncategorized media.
{% hint style="info" %}
You don't need to create lots of libraries with different directories, multiple libraries can share the same directory. You can set multiple (unlimited) libraries to the default directory `/data/movies` or `/data/tv` and use different rulesets with them.
{% endhint %}
!!! info
You don't need to create lots of libraries with different directories, multiple libraries can share the same directory. You can set multiple (unlimited) libraries to the default directory `/data/movies` or `/data/tv` and use different rulesets with them.
## Relation to Sonarr/Radarr Profiles

View File

@@ -1,12 +1,16 @@
# Developer Guide
---
description: >-
This section is for those who want to contribute to Media Manager or
understand its internals.
---
This section is for those who want to contribute to Media Manager or understand its internals.
# Developer Guide
## Source Code directory structure
* `media_manager/`: Backend FastAPI application
* `web/`: Frontend SvelteKit application
* `Writerside/`: Documentation
* `docs/`: Documentation (MkDocs)
* `metadata_relay/`: Metadata relay service, also FastAPI
## Special Dev Configuration
@@ -40,9 +44,8 @@ MediaManager uses various environment variables for configuration. In the Docker
* `DISABLE_FRONTEND_MOUNT`\
When `TRUE`, disables mounting built frontend files (allows separate frontend container).
{% hint style="info" %}
This is automatically set in `docker-compose.dev.yaml` to enable the separate frontend development container
{% endhint %}
!!! info
This is automatically set in `docker-compose.dev.yaml` to enable the separate frontend development container
#### Configuration Files
@@ -69,7 +72,6 @@ I use IntellijIdea with the Pycharm and Webstorm plugins to develop this, but th
* Pydantic
* Ruff
* VirtualKit
* Writerside (for writing documentation)
### Recommended Development Workflow
@@ -102,10 +104,9 @@ This means when your browser makes a request to `http://localhost:5173/api/v1/tv
### Setting up the full development environment with Docker (Recommended)
This is the easiest and recommended way to get started. Everything runs in Docker with hot-reloading enabled.
{% stepper %}
{% step %}
### Prepare config files
Create config directory (only needed on first run) and copy example config files:
@@ -115,9 +116,9 @@ mkdir -p res/config # Only needed on first run
cp config.dev.toml res/config/config.toml
cp web/.env.example web/.env
```
{% endstep %}
{% step %}
### Start all services
Recommended: Use make commands for easy development
@@ -132,9 +133,9 @@ Alternative: Use docker compose directly (if make is not available)
```bash
docker compose -f docker-compose.dev.yaml up
```
{% endstep %}
{% step %}
### Access the application
* Frontend (with HMR): http://localhost:5173
@@ -148,12 +149,10 @@ Now you can edit code and see changes instantly:
* Edit Python files → Backend auto-reloads
* Edit Svelte/TypeScript files → Frontend HMR updates in browser
* Edit config.toml → Changes apply immediately
{% endstep %}
{% endstepper %}
{% hint style="info" %}
Run `make help` to see all available development commands including `make down`, `make logs`, `make app` (shell into backend), and more.
{% endhint %}
!!! info
Run `make help` to see all available development commands including `make down`, `make logs`, `make app` (shell into backend), and more.
## Setting up the backend development environment (Local)
@@ -203,29 +202,28 @@ uv run fastapi run media_manager/main.py --reload --port 8000
* Format code:
```bash
uv run ruff format .
ruff format .
```
* Lint code:
```bash
uv run ruff check .
ruff check .
```
## Setting up the frontend development environment (Local, Optional)
Using the Docker setup above is recommended. This section is for those who prefer to run the frontend locally outside of Docker.
{% stepper %}
{% step %}
### Clone & change dir
1. Clone the repository
2. cd into repo root
3. cd into `web` directory
{% endstep %}
{% step %}
### Install Node.js (example using nvm-windows)
I used nvm-windows:
@@ -240,9 +238,9 @@ If using PowerShell you may need:
```powershell
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
```
{% endstep %}
{% step %}
### Create .env for frontend
```bash
@@ -250,18 +248,18 @@ cp .env.example .env
```
Update `PUBLIC_API_URL` if your backend is not at `http://localhost:8000`
{% endstep %}
{% step %}
### Install dependencies and run dev server
```bash
npm install
npm run dev
```
{% endstep %}
{% step %}
### Format & lint
* Format:
@@ -275,12 +273,10 @@ npm run format
```bash
npm run lint
```
{% endstep %}
{% endstepper %}
{% hint style="info" %}
If running frontend locally, make sure to add `http://localhost:5173` to the `cors_urls` in your backend config file.
{% endhint %}
!!! info
If running frontend locally, make sure to add `http://localhost:5173` to the `cors_urls` in your backend config file.
## Troubleshooting

View File

@@ -0,0 +1,14 @@
# Documentation
MediaManager uses [MkDocs](https://www.mkdocs.org/) with
the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme for documentation.
The files for the documentation are in the `/docs` directory.
To preview the documentation locally, you need to have mkdocs or Docker installed.
## How to preview the documentation locally with docker
1. Run the mkdocs container in `docker-compose.dev.yaml`
2. Open `http://127.0.0.1:9000/` in your browser.

View File

@@ -23,9 +23,8 @@ Here is an example, using these rules:
If your folder structure is in the correct format, you can start importing. To do this, log in as an administrator and go to the TV/movie dashboard.
{% hint style="info" %}
After importing, MediaManager will automatically prefix the old root TV show/movie folders with a dot to mark them as "imported".
{% endhint %}
!!! info
After importing, MediaManager will automatically prefix the old root TV show/movie folders with a dot to mark them as "imported".
So after importing, the directory would look like this (using the above directory structure):

2
docs/index.md Normal file
View File

@@ -0,0 +1,2 @@
--8<-- "README.md"

View File

@@ -0,0 +1,6 @@
# Installation Guide
The recommended way to install and run Media Manager is using Docker and Docker Compose. Other installation methods are not officially supported, but listed here for convenience.
[Docker Compose (recommended)](docker.md){ .md-button .md-button--primary }
[Nix Flakes [Community]](flakes.md){ .md-button }

View File

@@ -1,6 +1,4 @@
# Installation Guide
The recommended way to install and run Media Manager is using Docker and Docker Compose.
# Docker Compose
## Prerequisites
@@ -11,19 +9,19 @@ The recommended way to install and run Media Manager is using Docker and Docker
Follow these steps to get MediaManager running with Docker Compose:
{% stepper %}
{% step %}
### Get the docker-compose file
#### Get the docker-compose file
Download the `docker-compose.yaml` from the MediaManager repo:
```bash
wget -O docker-compose.yaml https://github.com/maxdorninger/MediaManager/releases/latest/download/docker-compose.yaml
```
{% endstep %}
{% step %}
### Prepare configuration directory and example config
#### Prepare configuration directory and example config
Create a config directory and download the example configuration:
@@ -31,34 +29,33 @@ Create a config directory and download the example configuration:
mkdir config
wget -O ./config/config.toml https://github.com/maxdorninger/MediaManager/releases/latest/download/config.example.toml
```
{% endstep %}
{% step %}
### Edit configuration
You probably need to edit the `config.toml` file in the `./config` directory to suit your environment and preferences. [How to configure MediaManager.](configuration/)
{% endstep %}
{% step %}
### Start MediaManager
#### Edit configuration
You probably need to edit the `config.toml` file in the `./config` directory to suit your environment and preferences. [How to configure MediaManager.](../configuration/README.md)
#### Start MediaManager
Bring up the stack:
```bash
docker compose up -d
```
{% endstep %}
{% endstepper %}
* Upon first run, MediaManager will create a default `config.toml` file in the `./config` directory (if not already present).
* Upon first run, MediaManager will also create a default admin user. The credentials of the default admin user will be printed in the logs of the container — it's recommended to change the password of this user after the first login.
* [For more information on the available configuration options, see the Configuration section of the documentation.](configuration/)
* [For more information on the available configuration options, see the Configuration section of the documentation.](../configuration/README.md)
{% hint style="info" %}
When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media, and settings.
{% endhint %}
!!! info
When setting up MediaManager for the first time, you should add your email to `admin_emails` in the `[auth]` config section. MediaManager will then use this email instead of the default admin email. Your account will automatically be created as an admin account, allowing you to manage other users, media, and settings.
## MediaManager and MetadataRelay Docker Images
## Docker Images
MediaManager is available as a Docker image on both Red Hat Quay.io and GitHub Container Registry (GHCR):
@@ -70,11 +67,10 @@ MetadataRelay images are also available on both registries:
* quay.io/maxdorninger/metadata\_relay
* ghcr.io/maxdorninger/mediamanager/metadata\_relay
From v1.12.1 onwards, both MediaManager and MetadataRelay images are available on both Quay.io and GHCR. The reason for the switch to Quay.io as the primary image registry is due to GHCR's continued slow performance: https://github.com/orgs/community/discussions/173607
From v1.12.1 onwards, both MediaManager and MetadataRelay images are available on both Quay.io and GHCR. The reason for the switch to Quay.io as the primary image registry is due to [GHCR's continued slow performance.](https://github.com/orgs/community/discussions/173607)
{% hint style="info" %}
You can use either the Quay.io or GHCR images interchangeably, as they are built from the same source and the tags are the same across both registries.
{% endhint %}
!!! info
You can use either the Quay.io or GHCR images interchangeably, as they are built from the same source and the tags are the same across both registries.
### Tags
@@ -85,4 +81,4 @@ Both registries support the following tags:
* X.Y.Z: Specific version tags (e.g., `1.12.0`).
* X.Y: Points to the latest release in the X.Y series (e.g., `1.12`).
* X: Points to the latest release in the X series (e.g., `1`).
* pr-: Points to the latest commit in the specified pull request (e.g., `pr-67`).
* pr-\<number>: Points to the latest commit in the specified pull request (e.g., `pr-67`).

124
docs/installation/flakes.md Normal file
View File

@@ -0,0 +1,124 @@
# Nix Flakes
!!! note
This is a community contribution and not officially supported by the MediaManager team, but included here for convenience.
*Please report issues with this method at the [corresponding GitHub repository](https://github.com/strangeglyph/mediamanager-nix).*
## Prerequisites
This guide assumes that your system is a flakes-based NixOS installation. Hosting MediaManager on a subpath (e.g. `yourdomain.com/mediamanager`) is currently not supported, though contributions to add support are welcome.
## Importing the community flake
To use the community-provided flake and module, first import it in your own flake, for example:
```nix
{
description = "An example NixOS configuration";
inputs = {
nixpkgs = { url = "github:nixos/nixpkgs/nixos-unstable"; };
mediamanager-nix = {
url = "github:strangeglyph/mediamanager-nix";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = inputs@{
nixpkgs,
mediamanager-nix,
...
}: {
nixosConfigurations.your-system = nixpkgs.lib.nixosSystem {
modules = [
mediamanager-nix.nixosModules.default
];
};
};
}
```
## Configuration
The flake provides a simple module to set up a MediaManager systemd service. To enable it, set
```nix
{
config = {
services.media-manager = {
enable = true;
};
};
}
```
You will either want to set `services.media-manager.dataDir`, which will provide sensible defaults for the settings
`misc.{image,movie,tv,torrent}_directory`, or provide specific paths yourself.
The host and port that MediaManager listens on can be set using `services.media-manager.{host,port}`.
To configure MediaManager, use `services.media-manager.settings`, which follows the same structure as the MediaManager
`config.toml`. To provision secrets, set `services.media-manager.environmentFile` to a protected file, for example one
provided by [agenix](https://github.com/ryantm/agenix) or [sops-nix](https://github.com/Mic92/sops-nix).
See [Configuration](../configuration/README.md#configuring-secrets) for guidance on using environment variables.
!!! warning
Do not place secrets in the nix store, as it is world-readable.
## Automatic Postgres Setup
As a convenience feature, the module provides a simple Postgres setup that can be enabled with `services.media-manager.postgres.enable`. This sets up a database user named `services.media-manager.postgres.user` and a database with the same name. Provided the user of the systemd service wasn't changed, authentication should work automatically for unix socket connections (the default mediamanager-nix settings).
For advanced setups, please refer to the NixOS manual.
## Example Configuration
Here is a minimal complete flake for a MediaManager setup:
```nix
{
description = "An example NixOS configuration";
inputs = {
nixpkgs = { url = "github:nixos/nixpkgs/nixos-unstable"; };
mediamanager-nix = {
url = "github:strangeglyph/mediamanager-nix";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = inputs@{
nixpkgs,
mediamanager-nix,
...
}: {
nixosConfigurations.your-system = nixpkgs.lib.nixosSystem {
imports = [
mediamanager-nix.nixosModules.default
];
config = {
services.media-manager = {
enable = true;
postgres.enable = true;
port = 12345;
dataDir = "/tmp";
settings = {
misc.frontend_url = "http://[::1]:12345";
};
};
systemd.tmpfiles.settings."10-mediamanager" = {
"/tmp/movies".d = { user = config.services.media-manager.user; };
"/tmp/shows".d = { user = config.services.media-manager.user; };
"/tmp/images".d = { user = config.services.media-manager.user; };
"/tmp/torrents".d = { user = config.services.media-manager.user; };
};
};
};
};
}
```

View File

@@ -1,7 +1,6 @@
# Screenshots
{% hint style="info" %}
MediaManager also supports darkmode!
{% endhint %}
!!! info
MediaManager also supports darkmode!
![screenshot-dashboard.png](<.gitbook/assets/screenshot dashboard.png>) ![screenshot-tv-dashboard.png](<.gitbook/assets/screenshot tv dashboard.png>) ![screenshot-download-season.png](<.gitbook/assets/screenshot download season.png>) ![screenshot-request-season.png](<.gitbook/assets/screenshot request season.png>) ![screenshot-tv-torrents.png](<.gitbook/assets/screenshot tv torrents.png>) ![screenshot-settings.png](<.gitbook/assets/screenshot settings.png>) ![screenshot-login.png](<.gitbook/assets/screenshot login.png>)
![screenshot-dashboard.png](<assets/assets/screenshot dashboard.png>) ![screenshot-tv-dashboard.png](<assets/assets/screenshot tv dashboard.png>) ![screenshot-download-season.png](<assets/assets/screenshot download season.png>) ![screenshot-request-season.png](<assets/assets/screenshot request season.png>) ![screenshot-tv-torrents.png](<assets/assets/screenshot tv torrents.png>) ![screenshot-settings.png](<assets/assets/screenshot settings.png>) ![screenshot-login.png](<assets/assets/screenshot login.png>)

View File

@@ -1,8 +1,7 @@
# Troubleshooting
{% hint style="info" %}
Always check the container and browser logs for more specific error messages
{% endhint %}
!!! info
Always check the container and browser logs for more specific error messages
<details>
@@ -60,10 +59,9 @@ Switch to advanced tabTry switching to the advanced tab when searching for torre
#### Possible Fixes:
* [Unable to pull image from GitHub Container Registry (Stack Overflow)](https://stackoverflow.com/questions/74656167/unable-to-pull-image-from-github-container-registry-ghcr)
* [Try pulling the image from Quay.io](installation-guide.md#mediamanager-and-metadatarelay-docker-images)
* [Try pulling the image from Quay.io](installation/docker.md#docker-images)
</details>
{% hint style="info" %}
If it still doesn't work, [please open an Issue.](https://github.com/maxdorninger/MediaManager/issues) It is possible that a bug is causing the issue.
{% endhint %}
!!! info
If it still doesn't work, [please open an Issue.](https://github.com/maxdorninger/MediaManager/issues) It is possible that a bug is causing the issue.

View File

@@ -1,133 +0,0 @@
# Usage
If you are coming from Radarr or Sonarr you will find that MediaManager does things a bit differently. Instead of completely automatically downloading and managing your media, MediaManager focuses on providing an easy-to-use interface to guide you through the process of finding and downloading media. Advanced features like multiple qualities of a show/movie necessitate such a paradigm shift. So here is a quick step-by-step guide to get you started:
#### Downloading/Requesting a show
{% stepper %}
{% step %}
### Add the show
Add a show on the "Add Show" page. After adding the show you will be redirected to the show's page.
{% endstep %}
{% step %}
### Request season(s)
Click the "Request Season" button on the show's page. Select one or more seasons that you want to download.
{% endstep %}
{% step %}
### Select qualities
Select the "Min Quality" — the minimum resolution of the content to download.\
Select the "Wanted Quality" — the **maximum** resolution of the content to download.
{% endstep %}
{% step %}
### Submit request
Click "Submit request". This is not the last step: an administrator must first approve your request for download. Only after approval will the requested content be downloaded.
{% endstep %}
{% step %}
### Finished
Congratulation! You've downloaded a show (after admin approval).
{% endstep %}
{% endstepper %}
#### Requesting a show (as an admin)
{% stepper %}
{% step %}
### Add the show
Add a show on the "Add Show" page. After adding the show you will be redirected to the show's page.
{% endstep %}
{% step %}
### Request season(s)
Click the "Request Season" button on the show's page. Select one or more seasons that you want to download.
{% endstep %}
{% step %}
### Select qualities
Select the "Min Quality" — the minimum resolution of the content to download.\
Select the "Wanted Quality" — the **maximum** resolution of the content to download.
{% endstep %}
{% step %}
### Submit request (auto-approved)
Click "Submit request". As an admin, your request will be automatically approved.
{% endstep %}
{% step %}
### Finished
Congratulation! You've downloaded a show.
{% endstep %}
{% endstepper %}
#### Downloading a show (admin-only)
You can only directly download a show if you are an admin!
{% stepper %}
{% step %}
### Go to the show's page
Open the show's page that contains the season you wish to download.
{% endstep %}
{% step %}
### Start download
Click the "Download Season" button.
{% endstep %}
{% step %}
### Enter season number
Enter the season number that you want to download.
{% endstep %}
{% step %}
### Optional file path suffix
Optionally select the "File Path Suffix". Note: **it needs to be unique per season per show!**
{% endstep %}
{% step %}
### Choose torrent and download
Click "Download" on the torrent that you want to download.
{% endstep %}
{% step %}
### Finished
Congratulation! You've downloaded a show.
{% endstep %}
{% endstepper %}
#### Managing requests
Users need their requests to be approved by an admin. To manage requests:
{% stepper %}
{% step %}
### Open Requests page
Go to the "Requests" page.
{% endstep %}
{% step %}
### Approve, delete or modify
From the Requests page you can approve, delete, or modify a user's request.
{% endstep %}
{% endstepper %}

View File

@@ -20,7 +20,3 @@ class AuthConfig(BaseSettings):
admin_emails: list[str] = []
email_password_resets: bool = False
openid_connect: OpenIdConfig = OpenIdConfig()
@property
def jwt_signing_key(self):
return self._jwt_signing_key

View File

@@ -1,5 +1,4 @@
from collections.abc import AsyncGenerator
from typing import Optional
from fastapi import Depends
from fastapi_users.db import (
@@ -17,7 +16,7 @@ from media_manager.database import Base, build_db_url
class OAuthAccount(SQLAlchemyBaseOAuthAccountTableUUID, Base):
access_token: Mapped[str] = mapped_column(String(length=4096), nullable=False)
refresh_token: Mapped[Optional[str]] = mapped_column(
refresh_token: Mapped[str | None] = mapped_column(
String(length=4096), nullable=True
)
@@ -34,10 +33,12 @@ engine = create_async_engine(
async_session_maker = async_sessionmaker(engine, expire_on_commit=False)
async def get_async_session() -> AsyncGenerator[AsyncSession, None]:
async def get_async_session() -> AsyncGenerator[AsyncSession]:
async with async_session_maker() as session:
yield session
async def get_user_db(session: AsyncSession = Depends(get_async_session)):
async def get_user_db(
session: AsyncSession = Depends(get_async_session),
) -> AsyncGenerator[SQLAlchemyUserDatabase]:
yield SQLAlchemyUserDatabase(session, User, OAuthAccount)

View File

@@ -1,4 +1,7 @@
from fastapi import APIRouter, Depends, status
from collections.abc import AsyncGenerator
from contextlib import asynccontextmanager
from fastapi import APIRouter, Depends, FastAPI, status
from fastapi_users.router import get_oauth_router
from httpx_oauth.oauth2 import OAuth2
from sqlalchemy import select
@@ -7,6 +10,7 @@ from media_manager.auth.db import User
from media_manager.auth.schemas import AuthMetadata, UserRead
from media_manager.auth.users import (
SECRET,
create_default_admin_user,
current_superuser,
fastapi_users,
openid_client,
@@ -15,11 +19,18 @@ from media_manager.auth.users import (
from media_manager.config import MediaManagerConfig
from media_manager.database import DbSessionDependency
users_router = APIRouter()
@asynccontextmanager
async def lifespan(_app: FastAPI) -> AsyncGenerator:
await create_default_admin_user()
yield
users_router = APIRouter(lifespan=lifespan)
auth_metadata_router = APIRouter()
def get_openid_router():
def get_openid_router() -> APIRouter:
if openid_client:
return get_oauth_router(
oauth_client=openid_client,

View File

@@ -1,7 +1,8 @@
import contextlib
import logging
import uuid
from typing import Any, Optional, override
from collections.abc import AsyncGenerator
from typing import Any, override
from fastapi import Depends, Request
from fastapi.responses import RedirectResponse, Response
@@ -49,7 +50,7 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
self,
user: models.UP,
update_dict: dict[str, Any],
request: Optional[Request] = None,
request: Request | None = None,
) -> None:
log.info(f"User {user.id} has been updated.")
if update_dict.get("is_superuser"):
@@ -59,7 +60,9 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
await self.update(user=user, user_update=updated_user)
@override
async def on_after_register(self, user: User, request: Optional[Request] = None):
async def on_after_register(
self, user: User, request: Request | None = None
) -> None:
log.info(f"User {user.id} has registered.")
if user.email in config.admin_emails:
updated_user = UserUpdate(is_superuser=True, is_verified=True)
@@ -67,8 +70,8 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
@override
async def on_after_forgot_password(
self, user: User, token: str, request: Optional[Request] = None
):
self, user: User, token: str, request: Request | None = None
) -> None:
link = f"{MediaManagerConfig().misc.frontend_url}web/login/reset-password?token={token}"
log.info(f"User {user.id} has forgot their password. Reset Link: {link}")
@@ -83,7 +86,7 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
<p>Hi {user.email},
<br>
<br>
if you forgot your password, <a href="{link}">reset you password here</a>.<br>
if you forgot your password, <a href=\"{link}\">reset you password here</a>.<br>
If you did not request a password reset, you can ignore this email.</p>
<br>
<br>
@@ -98,24 +101,26 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
@override
async def on_after_reset_password(
self, user: User, request: Optional[Request] = None
):
self, user: User, request: Request | None = None
) -> None:
log.info(f"User {user.id} has reset their password.")
@override
async def on_after_request_verify(
self, user: User, token: str, request: Optional[Request] = None
):
self, user: User, token: str, request: Request | None = None
) -> None:
log.info(
f"Verification requested for user {user.id}. Verification token: {token}"
)
@override
async def on_after_verify(self, user: User, request: Optional[Request] = None):
async def on_after_verify(self, user: User, request: Request | None = None) -> None:
log.info(f"User {user.id} has been verified")
async def get_user_manager(user_db: SQLAlchemyUserDatabase = Depends(get_user_db)):
async def get_user_manager(
user_db: SQLAlchemyUserDatabase = Depends(get_user_db),
) -> AsyncGenerator[UserManager]:
yield UserManager(user_db)
@@ -124,7 +129,7 @@ get_user_db_context = contextlib.asynccontextmanager(get_user_db)
get_user_manager_context = contextlib.asynccontextmanager(get_user_manager)
async def create_default_admin_user():
async def create_default_admin_user() -> None:
"""Create a default admin user if no users exist in the database"""
try:
async with get_async_session_context() as session:
@@ -170,17 +175,13 @@ async def create_default_admin_user():
log.info(
f"Found {user_count} existing users. Skipping default user creation."
)
except Exception as e:
log.error(f"Failed to create default admin user: {e}")
except Exception:
log.exception("Failed to create default admin user")
log.info(
"You can create an admin user manually by registering with an email from the admin_emails list in your config."
)
async def get_user_manager(user_db: SQLAlchemyUserDatabase = Depends(get_user_db)):
yield UserManager(user_db)
def get_jwt_strategy() -> JWTStrategy[models.UP, models.ID]:
return JWTStrategy(secret=SECRET, lifetime_seconds=LIFETIME)

View File

@@ -1,7 +1,6 @@
import logging
import os
from pathlib import Path
from typing import Tuple, Type
from pydantic import AnyHttpUrl
from pydantic_settings import (
@@ -41,7 +40,7 @@ class BasicConfig(BaseSettings):
movie_directory: Path = Path(__file__).parent.parent / "data" / "movies"
torrent_directory: Path = Path(__file__).parent.parent / "data" / "torrents"
frontend_url: AnyHttpUrl = "http://localhost:8000"
frontend_url: AnyHttpUrl = AnyHttpUrl("http://localhost:8000")
cors_urls: list[str] = []
development: bool = False
@@ -71,12 +70,12 @@ class MediaManagerConfig(BaseSettings):
@classmethod
def settings_customise_sources(
cls,
settings_cls: Type[BaseSettings],
settings_cls: type[BaseSettings],
init_settings: PydanticBaseSettingsSource,
env_settings: PydanticBaseSettingsSource,
dotenv_settings: PydanticBaseSettingsSource,
file_secret_settings: PydanticBaseSettingsSource,
) -> Tuple[PydanticBaseSettingsSource, ...]:
) -> tuple[PydanticBaseSettingsSource, ...]:
return (
init_settings,
env_settings,

View File

@@ -1,7 +1,8 @@
import logging
import os
from collections.abc import Generator
from contextvars import ContextVar
from typing import Annotated, Any, Generator, Optional
from typing import Annotated
from fastapi import Depends
from sqlalchemy import create_engine
@@ -9,12 +10,14 @@ from sqlalchemy.engine import Engine
from sqlalchemy.engine.url import URL
from sqlalchemy.orm import Session, declarative_base, sessionmaker
from media_manager.database.config import DbConfig
log = logging.getLogger(__name__)
Base = declarative_base()
engine: Optional[Engine] = None
SessionLocal: Optional[sessionmaker] = None
engine: Engine | None = None
SessionLocal: sessionmaker | None = None
def build_db_url(
@@ -35,7 +38,7 @@ def build_db_url(
def init_engine(
db_config: Any | None = None,
db_config: DbConfig | None = None,
url: str | URL | None = None,
) -> Engine:
"""
@@ -81,7 +84,7 @@ def get_engine() -> Engine:
return engine
def get_session() -> Generator[Session, Any, None]:
def get_session() -> Generator[Session]:
if SessionLocal is None:
msg = "Session factory not initialized. Call init_engine(...) first."
raise RuntimeError(msg)
@@ -89,9 +92,9 @@ def get_session() -> Generator[Session, Any, None]:
try:
yield db
db.commit()
except Exception as e:
except Exception:
db.rollback()
log.critical(f"error occurred: {e}")
log.critical("", exc_info=True)
raise
finally:
db.close()

View File

@@ -4,10 +4,17 @@ from psycopg.errors import UniqueViolation
from sqlalchemy.exc import IntegrityError
class RenameError(Exception):
"""Error when renaming something"""
def __init__(self, message: str = "Failed to rename source directory") -> None:
super().__init__(message)
class MediaManagerError(Exception):
"""Base exception for MediaManager errors."""
def __init__(self, message: str = "An error occurred."):
def __init__(self, message: str = "An error occurred.") -> None:
super().__init__(message)
self.message = message
@@ -17,76 +24,76 @@ class MediaAlreadyExistsError(MediaManagerError):
def __init__(
self, message: str = "Entity with this ID or other identifier already exists"
):
) -> None:
super().__init__(message)
class NotFoundError(MediaManagerError):
"""Raised when an entity is not found (HTTP 404)."""
def __init__(self, message: str = "The requested entity was not found."):
def __init__(self, message: str = "The requested entity was not found.") -> None:
super().__init__(message)
class InvalidConfigError(MediaManagerError):
"""Raised when the server is improperly configured (HTTP 500)."""
def __init__(self, message: str = "The server is improperly configured."):
def __init__(self, message: str = "The server is improperly configured.") -> None:
super().__init__(message)
class BadRequestError(MediaManagerError):
"""Raised for invalid client requests (HTTP 400)."""
def __init__(self, message: str = "Bad request."):
def __init__(self, message: str = "Bad request.") -> None:
super().__init__(message)
class UnauthorizedError(MediaManagerError):
"""Raised for authentication failures (HTTP 401)."""
def __init__(self, message: str = "Unauthorized."):
def __init__(self, message: str = "Unauthorized.") -> None:
super().__init__(message)
class ForbiddenError(MediaManagerError):
"""Raised for forbidden actions (HTTP 403)."""
def __init__(self, message: str = "Forbidden."):
def __init__(self, message: str = "Forbidden.") -> None:
super().__init__(message)
class ConflictError(MediaManagerError):
"""Raised for resource conflicts (HTTP 409)."""
def __init__(self, message: str = "Conflict."):
def __init__(self, message: str = "Conflict.") -> None:
super().__init__(message)
class UnprocessableEntityError(MediaManagerError):
"""Raised for validation errors (HTTP 422)."""
def __init__(self, message: str = "Unprocessable entity."):
def __init__(self, message: str = "Unprocessable entity.") -> None:
super().__init__(message)
# Exception handlers
async def media_already_exists_exception_handler(
_request: Request, exc: MediaAlreadyExistsError
_request: Request, _exc: Exception
) -> JSONResponse:
return JSONResponse(status_code=409, content={"detail": exc.message})
return JSONResponse(status_code=409, content={"detail": str(_exc)})
async def not_found_error_exception_handler(
_request: Request, exc: NotFoundError
_request: Request, _exc: Exception
) -> JSONResponse:
return JSONResponse(status_code=404, content={"detail": exc.message})
return JSONResponse(status_code=404, content={"detail": str(_exc)})
async def invalid_config_error_exception_handler(
_request: Request, exc: InvalidConfigError
_request: Request, _exc: Exception
) -> JSONResponse:
return JSONResponse(status_code=500, content={"detail": exc.message})
return JSONResponse(status_code=500, content={"detail": str(_exc)})
async def bad_request_error_handler(
@@ -107,8 +114,8 @@ async def forbidden_error_handler(
return JSONResponse(status_code=403, content={"detail": exc.message})
async def conflict_error_handler(_request: Request, exc: ConflictError) -> JSONResponse:
return JSONResponse(status_code=409, content={"detail": exc.message})
async def conflict_error_handler(_request: Request, _exc: Exception) -> JSONResponse:
return JSONResponse(status_code=409, content={"detail": str(_exc)})
async def unprocessable_entity_error_handler(
@@ -128,7 +135,7 @@ async def sqlalchemy_integrity_error_handler(
)
def register_exception_handlers(app: FastAPI):
def register_exception_handlers(app: FastAPI) -> None:
app.add_exception_handler(NotFoundError, not_found_error_exception_handler)
app.add_exception_handler(
MediaAlreadyExistsError, media_already_exists_exception_handler

View File

@@ -1,8 +1,11 @@
import shutil
from logging import Logger
from pathlib import Path
from media_manager.config import MediaManagerConfig
def run_filesystem_checks(config, log):
def run_filesystem_checks(config: MediaManagerConfig, log: Logger) -> None:
log.info("Creating directories if they don't exist...")
config.misc.tv_directory.mkdir(parents=True, exist_ok=True)
config.misc.movie_directory.mkdir(parents=True, exist_ok=True)
@@ -33,10 +36,8 @@ def run_filesystem_checks(config, log):
if not test_hardlink.samefile(test_torrent_file):
log.critical("Hardlink creation failed!")
log.info("Successfully created test hardlink in TV directory")
except OSError as e:
log.error(
f"Hardlink creation failed, falling back to copying files. Error: {e}"
)
except OSError:
log.exception("Hardlink creation failed, falling back to copying files")
shutil.copy(src=test_torrent_file, dst=test_hardlink)
finally:
test_hardlink.unlink()

View File

@@ -5,7 +5,6 @@ from fastapi import Depends
from media_manager.database import DbSessionDependency
from media_manager.indexer.repository import IndexerRepository
from media_manager.indexer.service import IndexerService
from media_manager.tv.service import TvService
def get_indexer_repository(db_session: DbSessionDependency) -> IndexerRepository:
@@ -21,4 +20,4 @@ def get_indexer_service(
return IndexerService(indexer_repository)
indexer_service_dep = Annotated[TvService, Depends(get_indexer_service)]
indexer_service_dep = Annotated[IndexerService, Depends(get_indexer_service)]

View File

@@ -8,7 +8,7 @@ from media_manager.tv.schemas import Show
class GenericIndexer(ABC):
name: str
def __init__(self, name: str):
def __init__(self, name: str) -> None:
self.name = name
@abstractmethod

View File

@@ -1,6 +1,9 @@
import concurrent
import concurrent.futures
import logging
import xml.etree.ElementTree as ET
from concurrent.futures.thread import ThreadPoolExecutor
from dataclasses import dataclass
import requests
@@ -14,8 +17,23 @@ from media_manager.tv.schemas import Show
log = logging.getLogger(__name__)
@dataclass
class IndexerInfo:
supports_tv_search: bool
supports_tv_search_tmdb: bool
supports_tv_search_imdb: bool
supports_tv_search_tvdb: bool
supports_tv_search_season: bool
supports_tv_search_episode: bool
supports_movie_search: bool
supports_movie_search_tmdb: bool
supports_movie_search_imdb: bool
supports_movie_search_tvdb: bool
class Jackett(GenericIndexer, TorznabMixin):
def __init__(self):
def __init__(self) -> None:
"""
A subclass of GenericIndexer for interacting with the Jacket API.
@@ -30,11 +48,16 @@ class Jackett(GenericIndexer, TorznabMixin):
def search(self, query: str, is_tv: bool) -> list[IndexerQueryResult]:
log.debug("Searching for " + query)
params = {"q": query, "t": "tvsearch" if is_tv else "movie"}
return self.__search_jackett(params)
def __search_jackett(self, params: dict) -> list[IndexerQueryResult]:
futures = []
with ThreadPoolExecutor() as executor, requests.Session() as session:
for indexer in self.indexers:
future = executor.submit(
self.get_torrents_by_indexer, indexer, query, is_tv, session
self.get_torrents_by_indexer, indexer, params, session
)
futures.append(future)
@@ -45,19 +68,108 @@ class Jackett(GenericIndexer, TorznabMixin):
result = future.result()
if result is not None:
responses.extend(result)
except Exception as e:
log.error(f"search result failed with: {e}")
except Exception:
log.exception("Searching failed")
return responses
def get_torrents_by_indexer(
self, indexer: str, query: str, is_tv: bool, session: requests.Session
) -> list[IndexerQueryResult]:
def __get_search_capabilities(
self, indexer: str, session: requests.Session
) -> IndexerInfo:
url = (
self.url
+ f"/api/v2.0/indexers/{indexer}/results/torznab/api?apikey={self.api_key}&t={'tvsearch' if is_tv else 'movie'}&q={query}"
+ f"/api/v2.0/indexers/{indexer}/results/torznab/api?apikey={self.api_key}&t=caps"
)
response = session.get(url, timeout=self.timeout_seconds)
if response.status_code != 200:
msg = f"Cannot get search capabilities for Indexer {indexer}"
log.error(msg)
raise RuntimeError(msg)
xml = response.text
xml_tree = ET.fromstring(xml) # noqa: S314 # trusted source, since it is user controlled
tv_search = xml_tree.find("./*/tv-search")
movie_search = xml_tree.find("./*/movie-search")
log.debug(tv_search.attrib)
log.debug(movie_search.attrib)
tv_search_capabilities = []
movie_search_capabilities = []
tv_search_available = (tv_search is not None) and (
tv_search.attrib["available"] == "yes"
)
movie_search_available = (movie_search is not None) and (
movie_search.attrib["available"] == "yes"
)
if tv_search_available:
tv_search_capabilities = tv_search.attrib["supportedParams"].split(",")
if movie_search_available:
movie_search_capabilities = movie_search.attrib["supportedParams"].split(
","
)
return IndexerInfo(
supports_tv_search=tv_search_available,
supports_tv_search_imdb="tmdbid" in tv_search_capabilities,
supports_tv_search_tmdb="tmdbid" in tv_search_capabilities,
supports_tv_search_tvdb="tvdbid" in tv_search_capabilities,
supports_tv_search_season="season" in tv_search_capabilities,
supports_tv_search_episode="ep" in tv_search_capabilities,
supports_movie_search=movie_search_available,
supports_movie_search_imdb="imdbid" in movie_search_capabilities,
supports_movie_search_tmdb="tmdbid" in movie_search_capabilities,
supports_movie_search_tvdb="tvdbid" in movie_search_capabilities,
)
def __get_optimal_query_parameters(
self, indexer: str, session: requests.Session, params: dict
) -> dict[str, str]:
query_params = {"apikey": self.api_key, "t": params["t"]}
search_capabilities = self.__get_search_capabilities(
indexer=indexer, session=session
)
if params["t"] == "tvsearch":
if not search_capabilities.supports_tv_search:
msg = f"Indexer {indexer} does not support TV search"
raise RuntimeError(msg)
if search_capabilities.supports_tv_search_season and "season" in params:
query_params["season"] = params["season"]
if search_capabilities.supports_tv_search_episode and "ep" in params:
query_params["ep"] = params["ep"]
if search_capabilities.supports_tv_search_imdb and "imdbid" in params:
query_params["imdbid"] = params["imdbid"]
elif search_capabilities.supports_tv_search_tvdb and "tvdbid" in params:
query_params["tvdbid"] = params["tvdbid"]
elif search_capabilities.supports_tv_search_tmdb and "tmdbid" in params:
query_params["tmdbid"] = params["tmdbid"]
else:
query_params["q"] = params["q"]
if params["t"] == "movie":
if not search_capabilities.supports_movie_search:
msg = f"Indexer {indexer} does not support Movie search"
raise RuntimeError(msg)
if search_capabilities.supports_movie_search_imdb and "imdbid" in params:
query_params["imdbid"] = params["imdbid"]
elif search_capabilities.supports_tv_search_tvdb and "tvdbid" in params:
query_params["tvdbid"] = params["tvdbid"]
elif search_capabilities.supports_tv_search_tmdb and "tmdbid" in params:
query_params["tmdbid"] = params["tmdbid"]
else:
query_params["q"] = params["q"]
return query_params
def get_torrents_by_indexer(
self, indexer: str, params: dict, session: requests.Session
) -> list[IndexerQueryResult]:
url = f"{self.url}/api/v2.0/indexers/{indexer}/results/torznab/api"
query_params = self.__get_optimal_query_parameters(
indexer=indexer, session=session, params=params
)
response = session.get(url, timeout=self.timeout_seconds, params=query_params)
log.debug(f"Indexer {indexer} url: {response.url}")
if response.status_code != 200:
log.error(
@@ -67,13 +179,30 @@ class Jackett(GenericIndexer, TorznabMixin):
results = self.process_search_result(response.content)
log.info(f"Indexer {indexer.name} returned {len(results)} results")
log.info(f"Indexer {indexer} returned {len(results)} results")
return results
def search_season(
self, query: str, show: Show, season_number: int
) -> list[IndexerQueryResult]:
pass
log.debug(f"Searching for season {season_number} of show {show.name}")
params = {
"t": "tvsearch",
"season": season_number,
"q": query,
}
if show.imdb_id:
params["imdbid"] = show.imdb_id
params[show.metadata_provider + "id"] = show.external_id
return self.__search_jackett(params=params)
def search_movie(self, query: str, movie: Movie) -> list[IndexerQueryResult]:
pass
log.debug(f"Searching for movie {movie.name}")
params = {
"t": "movie",
"q": query,
}
if movie.imdb_id:
params["imdbid"] = movie.imdb_id
params[movie.metadata_provider + "id"] = movie.external_id
return self.__search_jackett(params=params)

View File

@@ -1,7 +1,7 @@
import logging
from dataclasses import dataclass
from requests import Session
from requests import Response, Session
from media_manager.config import MediaManagerConfig
from media_manager.indexer.indexers.generic import GenericIndexer
@@ -31,14 +31,14 @@ class IndexerInfo:
class Prowlarr(GenericIndexer, TorznabMixin):
def __init__(self):
def __init__(self) -> None:
"""
A subclass of GenericIndexer for interacting with the Prowlarr API.
"""
super().__init__(name="prowlarr")
self.config = MediaManagerConfig().indexers.prowlarr
def _call_prowlarr_api(self, path: str, parameters: dict | None = None):
def _call_prowlarr_api(self, path: str, parameters: dict | None = None) -> Response:
url = f"{self.config.url}/api/v1{path}"
headers = {"X-Api-Key": self.config.api_key}
with Session() as session:

View File

@@ -1,6 +1,6 @@
import logging
import xml.etree.ElementTree as ET
from datetime import datetime, timezone
from datetime import datetime
from email.utils import parsedate_to_datetime
from media_manager.indexer.schemas import IndexerQueryResult
@@ -39,7 +39,7 @@ class TorznabMixin:
posted_date = parsedate_to_datetime(
attribute.attrib["value"]
)
now = datetime.now(timezone.utc)
now = datetime.now(datetime.UTC)
age = int((now - posted_date).total_seconds())
else:
if attribute.attrib["name"] == "seeders":
@@ -61,17 +61,28 @@ class TorznabMixin:
if upload_volume_factor == 2:
flags.append("doubleupload")
title = item.find("title").text
size_str = item.find("size")
if size_str is None or size_str.text is None:
log.warning(f"Torznab item {title} has no size, skipping.")
continue
try:
size = int(size_str.text or "0")
except ValueError:
log.warning(f"Torznab item {title} has invalid size, skipping.")
continue
result = IndexerQueryResult(
title=item.find("title").text,
title=title or "unknown",
download_url=str(item.find("enclosure").attrib["url"]),
seeders=seeders,
flags=flags,
size=int(item.find("size").text),
size=size,
usenet=is_usenet,
age=age,
indexer=indexer_name,
)
result_list.append(result)
except Exception as e:
log.error(f"1 Torznab search result errored with error: {e}")
except Exception:
log.exception("1 Torznab search result failed")
return result_list

View File

@@ -14,7 +14,7 @@ log = logging.getLogger(__name__)
class IndexerRepository:
def __init__(self, db: Session):
def __init__(self, db: Session) -> None:
self.db = db
def get_result(self, result_id: IndexerQueryResultId) -> IndexerQueryResultSchema:

View File

@@ -13,7 +13,9 @@ IndexerQueryResultId = typing.NewType("IndexerQueryResultId", UUID)
class IndexerQueryResult(BaseModel):
model_config = ConfigDict(from_attributes=True)
id: IndexerQueryResultId = pydantic.Field(default_factory=uuid4)
id: IndexerQueryResultId = pydantic.Field(
default_factory=lambda: IndexerQueryResultId(uuid4())
)
title: str
download_url: str = pydantic.Field(
exclude=True,
@@ -62,7 +64,7 @@ class IndexerQueryResult(BaseModel):
result = []
return result
def __gt__(self, other) -> bool:
def __gt__(self, other: "IndexerQueryResult") -> bool:
if self.quality.value != other.quality.value:
return self.quality.value < other.quality.value
if self.score != other.score:
@@ -76,7 +78,7 @@ class IndexerQueryResult(BaseModel):
return self.size < other.size
def __lt__(self, other) -> bool:
def __lt__(self, other: "IndexerQueryResult") -> bool:
if self.quality.value != other.quality.value:
return self.quality.value > other.quality.value
if self.score != other.score:

View File

@@ -14,7 +14,7 @@ log = logging.getLogger(__name__)
class IndexerService:
def __init__(self, indexer_repository: IndexerRepository):
def __init__(self, indexer_repository: IndexerRepository) -> None:
config = MediaManagerConfig()
self.repository = indexer_repository
self.indexers: list[GenericIndexer] = []
@@ -45,9 +45,9 @@ class IndexerService:
log.debug(
f"Indexer {indexer.__class__.__name__} returned {len(indexer_results)} results for query: {query}"
)
except Exception as e:
log.error(
f"Indexer {indexer.__class__.__name__} failed for query '{query}': {e}"
except Exception:
log.exception(
f"Indexer {indexer.__class__.__name__} failed for query '{query}'"
)
for result in results:
@@ -55,7 +55,7 @@ class IndexerService:
return results
def search_movie(self, movie: Movie):
def search_movie(self, movie: Movie) -> list[IndexerQueryResult]:
query = f"{movie.name} {movie.year}"
query = remove_special_chars_and_parentheses(query)
@@ -65,9 +65,9 @@ class IndexerService:
indexer_results = indexer.search_movie(query=query, movie=movie)
if indexer_results:
results.extend(indexer_results)
except Exception as e:
log.error(
f"Indexer {indexer.__class__.__name__} failed for movie search '{query}': {e}"
except Exception:
log.exception(
f"Indexer {indexer.__class__.__name__} failed for movie search '{query}'"
)
for result in results:
@@ -75,7 +75,7 @@ class IndexerService:
return results
def search_season(self, show: Show, season_number: int):
def search_season(self, show: Show, season_number: int) -> list[IndexerQueryResult]:
query = f"{show.name} {show.year} S{season_number:02d}"
query = remove_special_chars_and_parentheses(query)
@@ -87,9 +87,9 @@ class IndexerService:
)
if indexer_results:
results.extend(indexer_results)
except Exception as e:
log.error(
f"Indexer {indexer.__class__.__name__} failed for season search '{query}': {e}"
except Exception:
log.exception(
f"Indexer {indexer.__class__.__name__} failed for season search '{query}'"
)
for result in results:

View File

@@ -14,7 +14,7 @@ log = logging.getLogger(__name__)
def evaluate_indexer_query_result(
query_result: IndexerQueryResult, ruleset: ScoringRuleSet
) -> (IndexerQueryResult, bool):
) -> tuple[IndexerQueryResult, bool]:
title_rules = MediaManagerConfig().indexers.title_scoring_rules
indexer_flag_rules = MediaManagerConfig().indexers.indexer_flag_scoring_rules
for rule_name in ruleset.rule_names:
@@ -149,8 +149,11 @@ def follow_redirects_to_final_torrent_url(
raise RuntimeError(msg)
except requests.exceptions.RequestException as e:
log.debug(f"An error occurred during the request for {initial_url}: {e}")
msg = f"An error occurred during the request: {e}"
log.debug(
f"An error occurred during the request for {initial_url}",
exc_info=True,
)
msg = "An error occurred during the request"
raise RuntimeError(msg) from e
return current_url

View File

@@ -1,7 +1,7 @@
import logging
import os
import sys
from datetime import datetime, timezone
from datetime import UTC, datetime
from logging.config import dictConfig
from pathlib import Path
from typing import override
@@ -11,8 +11,8 @@ from pythonjsonlogger.json import JsonFormatter
class ISOJsonFormatter(JsonFormatter):
@override
def formatTime(self, record, datefmt=None):
dt = datetime.fromtimestamp(record.created, tz=timezone.utc)
def formatTime(self, record: logging.LogRecord, datefmt: str | None = None) -> str:
dt = datetime.fromtimestamp(record.created, tz=UTC)
return dt.isoformat(timespec="milliseconds").replace("+00:00", "Z")
@@ -21,13 +21,20 @@ LOG_FILE = Path(os.getenv("LOG_FILE", "/app/config/media_manager.log"))
LOGGING_CONFIG = {
"version": 1,
"disable_existing_loggers": False,
"filters": {
"correlation_id": {
"()": "asgi_correlation_id.CorrelationIdFilter",
"uuid_length": 32,
"default_value": "-",
},
},
"formatters": {
"default": {
"format": "%(asctime)s - %(levelname)s - %(name)s - %(funcName)s(): %(message)s"
"format": "%(asctime)s - [%(correlation_id)s] %(levelname)s - %(name)s - %(funcName)s(): %(message)s"
},
"json": {
"()": ISOJsonFormatter,
"format": "%(asctime)s %(levelname)s %(name)s %(message)s",
"format": "%(asctime)s %(correlation_id)s %(levelname)s %(name)s %(message)s",
"rename_fields": {
"levelname": "level",
"asctime": "timestamp",
@@ -39,11 +46,13 @@ LOGGING_CONFIG = {
"console": {
"class": "logging.StreamHandler",
"formatter": "default",
"filters": ["correlation_id"],
"stream": sys.stdout,
},
"file": {
"class": "logging.handlers.RotatingFileHandler",
"formatter": "json",
"filters": ["correlation_id"],
"filename": str(LOG_FILE),
"maxBytes": 10485760,
"backupCount": 5,
@@ -62,7 +71,7 @@ LOGGING_CONFIG = {
}
def setup_logging():
def setup_logging() -> None:
dictConfig(LOGGING_CONFIG)
logging.basicConfig(
level=LOG_LEVEL,

View File

@@ -2,12 +2,13 @@ import logging
import os
import uvicorn
from fastapi import APIRouter, FastAPI
from asgi_correlation_id import CorrelationIdMiddleware
from fastapi import APIRouter, FastAPI, Request, Response
from fastapi.middleware.cors import CORSMiddleware
from fastapi.staticfiles import StaticFiles
from psycopg.errors import UniqueViolation
from sqlalchemy.exc import IntegrityError
from starlette.responses import FileResponse, RedirectResponse, Response
from starlette.responses import FileResponse, RedirectResponse
from uvicorn.middleware.proxy_headers import ProxyHeadersMiddleware
import media_manager.movies.router as movies_router
@@ -71,6 +72,7 @@ app.add_middleware(
allow_credentials=True,
allow_methods=["GET", "PUT", "POST", "DELETE", "PATCH", "HEAD", "OPTIONS"],
)
app.add_middleware(CorrelationIdMiddleware, header_name="X-Correlation-ID")
api_app = APIRouter(prefix="/api/v1")
@@ -143,23 +145,23 @@ else:
@app.get("/")
async def root():
async def root() -> RedirectResponse:
return RedirectResponse(url="/web/")
@app.get("/dashboard")
async def dashboard():
async def dashboard() -> RedirectResponse:
return RedirectResponse(url="/web/")
@app.get("/login")
async def login():
async def login() -> RedirectResponse:
return RedirectResponse(url="/web/")
# this will serve the custom 404 page for frontend routes, so SvelteKit can handle routing
@app.exception_handler(404)
async def not_found_handler(request, _exc):
async def not_found_handler(request: Request, _exc: Exception) -> Response:
if not DISABLE_FRONTEND_MOUNT and any(
base_path in ["/web", "/dashboard", "/login"] for base_path in request.url.path
):

View File

@@ -18,15 +18,11 @@ class AbstractMetadataProvider(ABC):
pass
@abstractmethod
def get_show_metadata(
self, show_id: int | None = None, language: str | None = None
) -> Show:
def get_show_metadata(self, show_id: int, language: str | None = None) -> Show:
raise NotImplementedError()
@abstractmethod
def get_movie_metadata(
self, movie_id: int | None = None, language: str | None = None
) -> Movie:
def get_movie_metadata(self, movie_id: int, language: str | None = None) -> Movie:
raise NotImplementedError()
@abstractmethod

View File

@@ -21,7 +21,7 @@ log = logging.getLogger(__name__)
class TmdbMetadataProvider(AbstractMetadataProvider):
name = "tmdb"
def __init__(self):
def __init__(self) -> None:
config = MediaManagerConfig().metadata.tmdb
self.url = config.tmdb_relay_url
self.primary_languages = config.primary_languages
@@ -51,7 +51,7 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(f"TMDB API error getting show metadata for ID {show_id}: {e}")
log.exception(f"TMDB API error getting show metadata for ID {show_id}")
if notification_manager.is_configured():
notification_manager.send_notification(
title="TMDB API Error",
@@ -68,7 +68,7 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(f"TMDB API error getting show external IDs for ID {show_id}: {e}")
log.exception(f"TMDB API error getting show external IDs for ID {show_id}")
if notification_manager.is_configured():
notification_manager.send_notification(
title="TMDB API Error",
@@ -90,8 +90,8 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(
f"TMDB API error getting season {season_number} metadata for show ID {show_id}: {e}"
log.exception(
f"TMDB API error getting season {season_number} metadata for show ID {show_id}"
)
if notification_manager.is_configured():
notification_manager.send_notification(
@@ -113,7 +113,7 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(f"TMDB API error searching TV shows with query '{query}': {e}")
log.exception(f"TMDB API error searching TV shows with query '{query}'")
if notification_manager.is_configured():
notification_manager.send_notification(
title="TMDB API Error",
@@ -131,7 +131,7 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(f"TMDB API error getting trending TV: {e}")
log.exception("TMDB API error getting trending TV")
if notification_manager.is_configured():
notification_manager.send_notification(
title="TMDB API Error",
@@ -151,7 +151,7 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(f"TMDB API error getting movie metadata for ID {movie_id}: {e}")
log.exception(f"TMDB API error getting movie metadata for ID {movie_id}")
if notification_manager.is_configured():
notification_manager.send_notification(
title="TMDB API Error",
@@ -167,8 +167,8 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(
f"TMDB API error getting movie external IDs for ID {movie_id}: {e}"
log.exception(
f"TMDB API error getting movie external IDs for ID {movie_id}"
)
if notification_manager.is_configured():
notification_manager.send_notification(
@@ -190,7 +190,7 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(f"TMDB API error searching movies with query '{query}': {e}")
log.exception(f"TMDB API error searching movies with query '{query}'")
if notification_manager.is_configured():
notification_manager.send_notification(
title="TMDB API Error",
@@ -208,7 +208,7 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
response.raise_for_status()
return response.json()
except requests.RequestException as e:
log.error(f"TMDB API error getting trending movies: {e}")
log.exception("TMDB API error getting trending movies")
if notification_manager.is_configured():
notification_manager.send_notification(
title="TMDB API Error",
@@ -243,13 +243,11 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
return True
@override
def get_show_metadata(
self, show_id: int | None = None, language: str | None = None
) -> Show:
def get_show_metadata(self, show_id: int, language: str | None = None) -> Show:
"""
:param id: the external id of the show
:type id: int
:param show_id: the external id of the show
:type show_id: int
:param language: optional language code (ISO 639-1) to fetch metadata in
:type language: str | None
:return: returns a Show object
@@ -368,19 +366,17 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
original_language=original_language,
)
)
except Exception as e:
log.warning(f"Error processing search result: {e}")
except Exception:
log.warning("Error processing search result", exc_info=True)
return formatted_results
@override
def get_movie_metadata(
self, movie_id: int | None = None, language: str | None = None
) -> Movie:
def get_movie_metadata(self, movie_id: int, language: str | None = None) -> Movie:
"""
Get movie metadata with language-aware fetching.
:param id: the external id of the movie
:type id: int
:param movie_id: the external id of the movie
:type movie_id: int
:param language: optional language code (ISO 639-1) to fetch metadata in
:type language: str | None
:return: returns a Movie object
@@ -470,8 +466,8 @@ class TmdbMetadataProvider(AbstractMetadataProvider):
original_language=original_language,
)
)
except Exception as e:
log.warning(f"Error processing search result: {e}")
except Exception:
log.warning("Error processing search result", exc_info=True)
return formatted_results
@override

View File

@@ -18,7 +18,7 @@ log = logging.getLogger(__name__)
class TvdbMetadataProvider(AbstractMetadataProvider):
name = "tvdb"
def __init__(self):
def __init__(self) -> None:
config = MediaManagerConfig().metadata.tvdb
self.url = config.tvdb_relay_url
@@ -63,12 +63,10 @@ class TvdbMetadataProvider(AbstractMetadataProvider):
return False
@override
def get_show_metadata(
self, show_id: int | None = None, language: str | None = None
) -> Show:
def get_show_metadata(self, show_id: int, language: str | None = None) -> Show:
"""
:param id: the external id of the show
:param show_id: The external id of the show
:param language: does nothing, TVDB does not support multiple languages
"""
series = self.__get_show(show_id)
@@ -150,8 +148,8 @@ class TvdbMetadataProvider(AbstractMetadataProvider):
vote_average=None,
)
)
except Exception as e:
log.warning(f"Error processing search result: {e}")
except Exception:
log.warning("Error processing search result", exc_info=True)
return formatted_results
results = self.__get_trending_tv()
formatted_results = []
@@ -178,8 +176,8 @@ class TvdbMetadataProvider(AbstractMetadataProvider):
vote_average=None,
)
)
except Exception as e:
log.warning(f"Error processing search result: {e}")
except Exception:
log.warning("Error processing search result", exc_info=True)
return formatted_results
@override
@@ -215,8 +213,8 @@ class TvdbMetadataProvider(AbstractMetadataProvider):
vote_average=None,
)
)
except Exception as e:
log.warning(f"Error processing search result: {e}")
except Exception:
log.warning("Error processing search result", exc_info=True)
return formatted_results
results = self.__get_trending_movies()
results = results[0:20]
@@ -230,11 +228,16 @@ class TvdbMetadataProvider(AbstractMetadataProvider):
except KeyError:
year = None
if result.get("image"):
poster_path = "https://artworks.thetvdb.com" + str(
result.get("image")
)
else:
poster_path = None
formatted_results.append(
MetaDataProviderSearchResult(
poster_path="https://artworks.thetvdb.com" + result.get("image")
if result.get("image")
else None,
poster_path=poster_path if result.get("image") else None,
overview=result.get("overview"),
name=result["name"],
external_id=result["id"],
@@ -244,8 +247,8 @@ class TvdbMetadataProvider(AbstractMetadataProvider):
vote_average=None,
)
)
except Exception as e:
log.warning(f"Error processing search result: {e}")
except Exception:
log.warning("Error processing search result", exc_info=True)
return formatted_results
@override
@@ -264,16 +267,14 @@ class TvdbMetadataProvider(AbstractMetadataProvider):
return False
@override
def get_movie_metadata(
self, movie_id: int | None = None, language: str | None = None
) -> Movie:
def get_movie_metadata(self, movie_id: int, language: str | None = None) -> Movie:
"""
:param movie_id: the external id of the movie
:param language: does nothing, TVDB does not support multiple languages
:return: returns a Movie object
"""
movie = self.__get_movie(movie_id)
movie = self.__get_movie(movie_id=movie_id)
# get imdb id from remote ids
imdb_id = None

View File

@@ -15,7 +15,7 @@ def download_poster_image(storage_path: Path, poster_url: str, uuid: UUID) -> bo
res = requests.get(poster_url, stream=True, timeout=60)
if res.status_code == 200:
image_file_path = storage_path.joinpath(str(uuid)).with_suffix("jpg")
image_file_path = storage_path.joinpath(str(uuid)).with_suffix(".jpg")
image_file_path.write_bytes(res.content)
original_image = Image.open(image_file_path)

View File

@@ -40,7 +40,7 @@ class MovieRepository:
Provides methods to retrieve, save, and delete movies.
"""
def __init__(self, db: Session):
def __init__(self, db: Session) -> None:
self.db = db
def get_movie_by_id(self, movie_id: MovieId) -> MovieSchema:
@@ -59,8 +59,8 @@ class MovieRepository:
msg = f"Movie with id {movie_id} not found."
raise NotFoundError(msg)
return MovieSchema.model_validate(result)
except SQLAlchemyError as e:
log.error(f"Database error while retrieving movie {movie_id}: {e}")
except SQLAlchemyError:
log.exception(f"Database error while retrieving movie {movie_id}")
raise
def get_movie_by_external_id(
@@ -86,9 +86,9 @@ class MovieRepository:
msg = f"Movie with external_id {external_id} and provider {metadata_provider} not found."
raise NotFoundError(msg)
return MovieSchema.model_validate(result)
except SQLAlchemyError as e:
log.error(
f"Database error while retrieving movie by external_id {external_id}: {e}"
except SQLAlchemyError:
log.exception(
f"Database error while retrieving movie by external_id {external_id}"
)
raise
@@ -103,8 +103,8 @@ class MovieRepository:
stmt = select(Movie)
results = self.db.execute(stmt).scalars().unique().all()
return [MovieSchema.model_validate(movie) for movie in results]
except SQLAlchemyError as e:
log.error(f"Database error while retrieving all movies: {e}")
except SQLAlchemyError:
log.exception("Database error while retrieving all movies")
raise
def save_movie(self, movie: MovieSchema) -> MovieSchema:
@@ -140,14 +140,14 @@ class MovieRepository:
return MovieSchema.model_validate(db_movie)
except IntegrityError as e:
self.db.rollback()
log.error(f"Integrity error while saving movie {movie.name}: {e}")
log.exception(f"Integrity error while saving movie {movie.name}")
msg = (
f"Movie with this primary key or unique constraint violation: {e.orig}"
)
raise ConflictError(msg) from e
except SQLAlchemyError as e:
except SQLAlchemyError:
self.db.rollback()
log.error(f"Database error while saving movie {movie.name}: {e}")
log.exception(f"Database error while saving movie {movie.name}")
raise
def delete_movie(self, movie_id: MovieId) -> None:
@@ -168,9 +168,9 @@ class MovieRepository:
self.db.delete(movie)
self.db.commit()
log.info(f"Successfully deleted movie with id: {movie_id}")
except SQLAlchemyError as e:
except SQLAlchemyError:
self.db.rollback()
log.error(f"Database error while deleting movie {movie_id}: {e}")
log.exception(f"Database error while deleting movie {movie_id}")
raise
def add_movie_request(
@@ -204,13 +204,13 @@ class MovieRepository:
self.db.refresh(db_model)
log.info(f"Successfully added movie request with id: {db_model.id}")
return MovieRequestSchema.model_validate(db_model)
except IntegrityError as e:
except IntegrityError:
self.db.rollback()
log.error(f"Integrity error while adding movie request: {e}")
log.exception("Integrity error while adding movie request")
raise
except SQLAlchemyError as e:
except SQLAlchemyError:
self.db.rollback()
log.error(f"Database error while adding movie request: {e}")
log.exception("Database error while adding movie request")
raise
def set_movie_library(self, movie_id: MovieId, library: str) -> None:
@@ -229,9 +229,9 @@ class MovieRepository:
raise NotFoundError(msg)
movie.library = library
self.db.commit()
except SQLAlchemyError as e:
except SQLAlchemyError:
self.db.rollback()
log.error(f"Database error setting library for movie {movie_id}: {e}")
log.exception(f"Database error setting library for movie {movie_id}")
raise
def delete_movie_request(self, movie_request_id: MovieRequestId) -> None:
@@ -251,10 +251,10 @@ class MovieRepository:
raise NotFoundError(msg)
self.db.commit()
# Successfully deleted movie request with id: {movie_request_id}
except SQLAlchemyError as e:
except SQLAlchemyError:
self.db.rollback()
log.error(
f"Database error while deleting movie request {movie_request_id}: {e}"
log.exception(
f"Database error while deleting movie request {movie_request_id}"
)
raise
@@ -273,8 +273,8 @@ class MovieRepository:
)
results = self.db.execute(stmt).scalars().unique().all()
return [RichMovieRequestSchema.model_validate(x) for x in results]
except SQLAlchemyError as e:
log.error(f"Database error while retrieving movie requests: {e}")
except SQLAlchemyError:
log.exception("Database error while retrieving movie requests")
raise
def add_movie_file(self, movie_file: MovieFileSchema) -> MovieFileSchema:
@@ -292,13 +292,13 @@ class MovieRepository:
self.db.commit()
self.db.refresh(db_model)
return MovieFileSchema.model_validate(db_model)
except IntegrityError as e:
except IntegrityError:
self.db.rollback()
log.error(f"Integrity error while adding movie file: {e}")
log.exception("Integrity error while adding movie file")
raise
except SQLAlchemyError as e:
except SQLAlchemyError:
self.db.rollback()
log.error(f"Database error while adding movie file: {e}")
log.exception("Database error while adding movie file")
raise
def remove_movie_files_by_torrent_id(self, torrent_id: TorrentId) -> int:
@@ -313,14 +313,15 @@ class MovieRepository:
stmt = delete(MovieFile).where(MovieFile.torrent_id == torrent_id)
result = self.db.execute(stmt)
self.db.commit()
return result.rowcount
except SQLAlchemyError as e:
except SQLAlchemyError:
self.db.rollback()
log.error(
f"Database error removing movie files for torrent_id {torrent_id}: {e}"
log.exception(
f"Database error removing movie files for torrent_id {torrent_id}"
)
raise
return result.rowcount
def get_movie_files_by_movie_id(self, movie_id: MovieId) -> list[MovieFileSchema]:
"""
Retrieve all movie files for a given movie ID.
@@ -333,9 +334,9 @@ class MovieRepository:
stmt = select(MovieFile).where(MovieFile.movie_id == movie_id)
results = self.db.execute(stmt).scalars().all()
return [MovieFileSchema.model_validate(sf) for sf in results]
except SQLAlchemyError as e:
log.error(
f"Database error retrieving movie files for movie_id {movie_id}: {e}"
except SQLAlchemyError:
log.exception(
f"Database error retrieving movie files for movie_id {movie_id}"
)
raise
@@ -367,13 +368,13 @@ class MovieRepository:
usenet=torrent.usenet,
)
formatted_results.append(movie_torrent)
return formatted_results
except SQLAlchemyError as e:
log.error(
f"Database error retrieving torrents for movie_id {movie_id}: {e}"
)
except SQLAlchemyError:
log.exception(f"Database error retrieving torrents for movie_id {movie_id}")
raise
return formatted_results
def get_all_movies_with_torrents(self) -> list[MovieSchema]:
"""
Retrieve all movies that are associated with a torrent, ordered alphabetically by movie name.
@@ -391,8 +392,8 @@ class MovieRepository:
)
results = self.db.execute(stmt).scalars().unique().all()
return [MovieSchema.model_validate(movie) for movie in results]
except SQLAlchemyError as e:
log.error(f"Database error retrieving all movies with torrents: {e}")
except SQLAlchemyError:
log.exception("Database error retrieving all movies with torrents")
raise
def get_movie_request(self, movie_request_id: MovieRequestId) -> MovieRequestSchema:
@@ -410,10 +411,8 @@ class MovieRepository:
msg = f"Movie request with id {movie_request_id} not found."
raise NotFoundError(msg)
return MovieRequestSchema.model_validate(request)
except SQLAlchemyError as e:
log.error(
f"Database error retrieving movie request {movie_request_id}: {e}"
)
except SQLAlchemyError:
log.exception(f"Database error retrieving movie request {movie_request_id}")
raise
def get_movie_by_torrent_id(self, torrent_id: TorrentId) -> MovieSchema:
@@ -436,10 +435,8 @@ class MovieRepository:
msg = f"Movie for torrent_id {torrent_id} not found."
raise NotFoundError(msg)
return MovieSchema.model_validate(result)
except SQLAlchemyError as e:
log.error(
f"Database error retrieving movie by torrent_id {torrent_id}: {e}"
)
except SQLAlchemyError:
log.exception(f"Database error retrieving movie by torrent_id {torrent_id}")
raise
def update_movie_attributes(

View File

@@ -6,7 +6,7 @@ from fastapi import APIRouter, Depends, HTTPException, status
from media_manager.auth.schemas import UserRead
from media_manager.auth.users import current_active_user, current_superuser
from media_manager.config import LibraryItem, MediaManagerConfig
from media_manager.exceptions import ConflictError
from media_manager.exceptions import ConflictError, NotFoundError
from media_manager.indexer.schemas import (
IndexerQueryResult,
IndexerQueryResultId,
@@ -97,7 +97,7 @@ def get_all_importable_movies(
)
def import_detected_movie(
movie_service: movie_service_dep, movie: movie_dep, directory: str
):
) -> None:
"""
Import a detected movie from the specified directory into the library.
"""
@@ -145,7 +145,7 @@ def add_a_movie(
metadata_provider: metadata_provider_dep,
movie_id: int,
language: str | None = None,
):
) -> Movie:
"""
Add a new movie to the library.
"""
@@ -159,6 +159,8 @@ def add_a_movie(
movie = movie_service.get_movie_by_external_id(
external_id=movie_id, metadata_provider=metadata_provider.name
)
if not movie:
raise NotFoundError from ConflictError
return movie
@@ -217,7 +219,7 @@ def create_movie_request(
log.info(
f"User {user.email} is creating a movie request for {movie_request.movie_id}"
)
movie_request = MovieRequest.model_validate(movie_request)
movie_request: MovieRequest = MovieRequest.model_validate(movie_request)
movie_request.requested_by = user
if user.is_superuser:
movie_request.authorized = True
@@ -254,7 +256,7 @@ def authorize_request(
movie_request_id: MovieRequestId,
user: Annotated[UserRead, Depends(current_superuser)],
authorized_status: bool = False,
):
) -> None:
"""
Authorize or de-authorize a movie request.
"""
@@ -266,7 +268,7 @@ def authorize_request(
movie_request.authorized_by = user
else:
movie_request.authorized_by = None
return movie_service.update_movie_request(movie_request=movie_request)
movie_service.update_movie_request(movie_request=movie_request)
@router.delete(
@@ -276,7 +278,7 @@ def authorize_request(
)
def delete_movie_request(
movie_service: movie_service_dep, movie_request_id: MovieRequestId
):
) -> None:
"""
Delete a movie request.
"""
@@ -309,7 +311,7 @@ def delete_a_movie(
movie: movie_dep,
delete_files_on_disk: bool = False,
delete_torrents: bool = False,
):
) -> None:
"""
Delete a movie from the library.
"""

View File

@@ -15,7 +15,7 @@ MovieRequestId = typing.NewType("MovieRequestId", UUID)
class Movie(BaseModel):
model_config = ConfigDict(from_attributes=True)
id: MovieId = Field(default_factory=uuid.uuid4)
id: MovieId = Field(default_factory=lambda: MovieId(uuid.uuid4()))
name: str
overview: str
year: int | None
@@ -59,7 +59,7 @@ class CreateMovieRequest(MovieRequestBase):
class MovieRequest(MovieRequestBase):
model_config = ConfigDict(from_attributes=True)
id: MovieRequestId = Field(default_factory=uuid.uuid4)
id: MovieRequestId = Field(default_factory=lambda: MovieRequestId(uuid.uuid4()))
movie_id: MovieId

View File

@@ -8,7 +8,7 @@ from sqlalchemy.orm import Session
from media_manager.config import MediaManagerConfig
from media_manager.database import SessionLocal, get_session
from media_manager.exceptions import InvalidConfigError, NotFoundError
from media_manager.exceptions import InvalidConfigError, NotFoundError, RenameError
from media_manager.indexer.repository import IndexerRepository
from media_manager.indexer.schemas import IndexerQueryResult, IndexerQueryResultId
from media_manager.indexer.service import IndexerService
@@ -32,6 +32,7 @@ from media_manager.movies.schemas import (
RichMovieRequest,
RichMovieTorrent,
)
from media_manager.notification.repository import NotificationRepository
from media_manager.notification.service import NotificationService
from media_manager.schemas import MediaImportSuggestion
from media_manager.torrent.repository import TorrentRepository
@@ -58,8 +59,8 @@ class MovieService:
movie_repository: MovieRepository,
torrent_service: TorrentService,
indexer_service: IndexerService,
notification_service: NotificationService = None,
):
notification_service: NotificationService,
) -> None:
self.movie_repository = movie_repository
self.torrent_service = torrent_service
self.indexer_service = indexer_service
@@ -70,7 +71,7 @@ class MovieService:
external_id: int,
metadata_provider: AbstractMetadataProvider,
language: str | None = None,
) -> Movie | None:
) -> Movie:
"""
Add a new movie to the database.
@@ -82,7 +83,7 @@ class MovieService:
movie_id=external_id, language=language
)
if not movie_with_metadata:
return None
raise NotFoundError
saved_movie = self.movie_repository.save_movie(movie=movie_with_metadata)
metadata_provider.download_movie_poster_image(movie=saved_movie)
@@ -97,9 +98,7 @@ class MovieService:
"""
return self.movie_repository.add_movie_request(movie_request=movie_request)
def get_movie_request_by_id(
self, movie_request_id: MovieRequestId
) -> MovieRequest | None:
def get_movie_request_by_id(self, movie_request_id: MovieRequestId) -> MovieRequest:
"""
Get a movie request by its ID.
@@ -150,10 +149,8 @@ class MovieService:
try:
shutil.rmtree(movie_dir)
log.info(f"Deleted movie directory: {movie_dir}")
except OSError as e:
log.error(
f"Deleting movie directory: {movie_dir} : {e.strerror}"
)
except OSError:
log.exception(f"Deleting movie directory: {movie_dir}")
if delete_torrents:
# Get all torrents associated with this movie
@@ -170,8 +167,10 @@ class MovieService:
torrent=torrent, delete_files=True
)
log.info(f"Deleted torrent: {torrent.torrent_title}")
except Exception as e:
log.warning(f"Failed to delete torrent {torrent.hash}: {e}")
except Exception:
log.warning(
f"Failed to delete torrent {torrent.hash}", exc_info=True
)
# Delete from database
self.movie_repository.delete_movie(movie_id=movie.id)
@@ -236,19 +235,19 @@ class MovieService:
self.movie_repository.get_movie_by_external_id(
external_id=external_id, metadata_provider=metadata_provider
)
return True
except NotFoundError:
return False
elif movie_id is not None:
try:
self.movie_repository.get_movie_by_id(movie_id=movie_id)
return True
except NotFoundError:
return False
else:
msg = "Use one of the provided overloads for this function!"
raise ValueError(msg)
return True
def get_all_available_torrents_for_movie(
self, movie: Movie, search_query_override: str | None = None
) -> list[IndexerQueryResult]:
@@ -569,8 +568,8 @@ class MovieService:
try:
movie_root_path.mkdir(parents=True, exist_ok=True)
except Exception as e:
log.error(f"Failed to create directory {movie_root_path}: {e}")
except Exception:
log.exception("Failed to create directory {movie_root_path}")
return False
# import movie video
@@ -681,9 +680,8 @@ class MovieService:
try:
source_directory.rename(new_source_path)
except Exception as e:
log.error(f"Failed to rename {source_directory} to {new_source_path}: {e}")
msg = "Failed to rename directory"
raise Exception(msg) from e
log.exception(f"Failed to rename {source_directory} to {new_source_path}")
raise RenameError from e
video_files, subtitle_files, _all_files = get_files_for_import(
directory=new_source_path
@@ -781,14 +779,18 @@ def auto_download_all_approved_movie_requests() -> None:
Auto download all approved movie requests.
This is a standalone function as it creates its own DB session.
"""
db: Session = SessionLocal()
db: Session = SessionLocal() if SessionLocal else next(get_session())
movie_repository = MovieRepository(db=db)
torrent_service = TorrentService(torrent_repository=TorrentRepository(db=db))
indexer_service = IndexerService(indexer_repository=IndexerRepository(db=db))
notification_service = NotificationService(
notification_repository=NotificationRepository(db=db)
)
movie_service = MovieService(
movie_repository=movie_repository,
torrent_service=torrent_service,
indexer_service=indexer_service,
notification_service=notification_service,
)
log.info("Auto downloading all approved movie requests")
@@ -818,10 +820,14 @@ def import_all_movie_torrents() -> None:
movie_repository = MovieRepository(db=db)
torrent_service = TorrentService(torrent_repository=TorrentRepository(db=db))
indexer_service = IndexerService(indexer_repository=IndexerRepository(db=db))
notification_service = NotificationService(
notification_repository=NotificationRepository(db=db)
)
movie_service = MovieService(
movie_repository=movie_repository,
torrent_service=torrent_service,
indexer_service=indexer_service,
notification_service=notification_service,
)
log.info("Importing all torrents")
torrents = torrent_service.get_all_torrents()
@@ -836,11 +842,8 @@ def import_all_movie_torrents() -> None:
)
continue
movie_service.import_torrent_files(torrent=t, movie=movie)
except RuntimeError as e:
log.error(
f"Failed to import torrent {t.title}: {e}",
exc_info=True,
)
except RuntimeError:
log.exception(f"Failed to import torrent {t.title}")
log.info("Finished importing all torrents")
db.commit()
@@ -855,6 +858,9 @@ def update_all_movies_metadata() -> None:
movie_repository=movie_repository,
torrent_service=TorrentService(torrent_repository=TorrentRepository(db=db)),
indexer_service=IndexerService(indexer_repository=IndexerRepository(db=db)),
notification_service=NotificationService(
notification_repository=NotificationRepository(db=db)
),
)
log.info("Updating metadata for all movies")
@@ -874,9 +880,9 @@ def update_all_movies_metadata() -> None:
f"Unsupported metadata provider {movie.metadata_provider} for movie {movie.name}, skipping update."
)
continue
except InvalidConfigError as e:
log.error(
f"Error initializing metadata provider {movie.metadata_provider} for movie {movie.name}: {e}"
except InvalidConfigError:
log.exception(
f"Error initializing metadata provider {movie.metadata_provider} for movie {movie.name}",
)
continue
movie_service.update_movie_metadata(

View File

@@ -3,7 +3,6 @@ Notification Manager - Orchestrates sending notifications through all configured
"""
import logging
from typing import List
from media_manager.config import MediaManagerConfig
from media_manager.notification.schemas import MessageNotification
@@ -31,9 +30,9 @@ class NotificationManager:
Manages and orchestrates notifications across all configured service providers.
"""
def __init__(self):
def __init__(self) -> None:
self.config = MediaManagerConfig().notifications
self.providers: List[AbstractNotificationServiceProvider] = []
self.providers: list[AbstractNotificationServiceProvider] = []
self._initialize_providers()
def _initialize_providers(self) -> None:
@@ -42,32 +41,32 @@ class NotificationManager:
try:
self.providers.append(EmailNotificationServiceProvider())
logger.info("Email notification provider initialized")
except Exception as e:
logger.error(f"Failed to initialize Email provider: {e}")
except Exception:
logger.exception("Failed to initialize Email provider")
# Gotify provider
if self.config.gotify.enabled:
try:
self.providers.append(GotifyNotificationServiceProvider())
logger.info("Gotify notification provider initialized")
except Exception as e:
logger.error(f"Failed to initialize Gotify provider: {e}")
except Exception:
logger.exception("Failed to initialize Gotify provider")
# Ntfy provider
if self.config.ntfy.enabled:
try:
self.providers.append(NtfyNotificationServiceProvider())
logger.info("Ntfy notification provider initialized")
except Exception as e:
logger.error(f"Failed to initialize Ntfy provider: {e}")
except Exception:
logger.exception("Failed to initialize Ntfy provider")
# Pushover provider
if self.config.pushover.enabled:
try:
self.providers.append(PushoverNotificationServiceProvider())
logger.info("Pushover notification provider initialized")
except Exception as e:
logger.error(f"Failed to initialize Pushover provider: {e}")
except Exception:
logger.exception("Failed to initialize Pushover provider")
logger.info(f"Initialized {len(self.providers)} notification providers")
@@ -86,10 +85,10 @@ class NotificationManager:
else:
logger.warning(f"Failed to send notification via {provider_name}")
except Exception as e:
logger.error(f"Error sending notification via {provider_name}: {e}")
except Exception:
logger.exception(f"Error sending notification via {provider_name}")
def get_configured_providers(self) -> List[str]:
def get_configured_providers(self) -> list[str]:
return [provider.__class__.__name__ for provider in self.providers]
def is_configured(self) -> bool:

View File

@@ -6,6 +6,7 @@ from sqlalchemy.exc import (
SQLAlchemyError,
)
from sqlalchemy.orm import Session
from sqlalchemy.sql.expression import false
from media_manager.exceptions import ConflictError, NotFoundError
from media_manager.notification.models import Notification
@@ -20,7 +21,7 @@ log = logging.getLogger(__name__)
class NotificationRepository:
def __init__(self, db: Session):
def __init__(self, db: Session) -> None:
self.db = db
def get_notification(self, nid: NotificationId) -> NotificationSchema:
@@ -36,7 +37,7 @@ class NotificationRepository:
try:
stmt = (
select(Notification)
.where(Notification.read == False) # noqa: E712
.where(Notification.read == false())
.order_by(Notification.timestamp.desc())
)
results = self.db.execute(stmt).scalars().all()
@@ -44,8 +45,8 @@ class NotificationRepository:
NotificationSchema.model_validate(notification)
for notification in results
]
except SQLAlchemyError as e:
log.error(f"Database error while retrieving unread notifications: {e}")
except SQLAlchemyError:
log.exception("Database error while retrieving unread notifications")
raise
def get_all_notifications(self) -> list[NotificationSchema]:
@@ -56,11 +57,11 @@ class NotificationRepository:
NotificationSchema.model_validate(notification)
for notification in results
]
except SQLAlchemyError as e:
log.error(f"Database error while retrieving notifications: {e}")
except SQLAlchemyError:
log.exception("Database error while retrieving notifications")
raise
def save_notification(self, notification: NotificationSchema):
def save_notification(self, notification: NotificationSchema) -> None:
try:
self.db.add(
Notification(
@@ -71,8 +72,8 @@ class NotificationRepository:
)
)
self.db.commit()
except IntegrityError as e:
log.error(f"Could not save notification, Error: {e}")
except IntegrityError:
log.exception("Could not save notification")
msg = f"Notification with id {notification.id} already exists."
raise ConflictError(msg) from None
return

View File

@@ -69,7 +69,7 @@ def get_notification(
)
def mark_notification_as_read(
notification_id: NotificationId, notification_service: notification_service_dep
):
) -> None:
"""
Mark a notification as read.
"""
@@ -86,7 +86,7 @@ def mark_notification_as_read(
)
def mark_notification_as_unread(
notification_id: NotificationId, notification_service: notification_service_dep
):
) -> None:
"""
Mark a notification as unread.
"""
@@ -103,7 +103,7 @@ def mark_notification_as_unread(
)
def delete_notification(
notification_id: NotificationId, notification_service: notification_service_dep
):
) -> None:
"""
Delete a notification.
"""

View File

@@ -12,7 +12,8 @@ class Notification(BaseModel):
model_config = ConfigDict(from_attributes=True)
id: NotificationId = Field(
default_factory=uuid.uuid4, description="Unique identifier for the notification"
default_factory=lambda: NotificationId(uuid.uuid4()),
description="Unique identifier for the notification",
)
read: bool = Field(False, description="Whether the notification has been read")
message: str = Field(description="The content of the notification")

View File

@@ -7,7 +7,7 @@ class NotificationService:
def __init__(
self,
notification_repository: NotificationRepository,
):
) -> None:
self.notification_repository = notification_repository
self.notification_manager = notification_manager

View File

@@ -7,7 +7,7 @@ from media_manager.notification.service_providers.abstract_notification_service_
class EmailNotificationServiceProvider(AbstractNotificationServiceProvider):
def __init__(self):
def __init__(self) -> None:
self.config = MediaManagerConfig().notifications.email_notifications
def send_notification(self, message: MessageNotification) -> bool:

View File

@@ -12,7 +12,7 @@ class GotifyNotificationServiceProvider(AbstractNotificationServiceProvider):
Gotify Notification Service Provider
"""
def __init__(self):
def __init__(self) -> None:
self.config = MediaManagerConfig().notifications.gotify
def send_notification(self, message: MessageNotification) -> bool:

View File

@@ -12,7 +12,7 @@ class NtfyNotificationServiceProvider(AbstractNotificationServiceProvider):
Ntfy Notification Service Provider
"""
def __init__(self):
def __init__(self) -> None:
self.config = MediaManagerConfig().notifications.ntfy
def send_notification(self, message: MessageNotification) -> bool:

View File

@@ -8,7 +8,7 @@ from media_manager.notification.service_providers.abstract_notification_service_
class PushoverNotificationServiceProvider(AbstractNotificationServiceProvider):
def __init__(self):
def __init__(self) -> None:
self.config = MediaManagerConfig().notifications.pushover
def send_notification(self, message: MessageNotification) -> bool:

View File

@@ -3,6 +3,7 @@ from apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.triggers.cron import CronTrigger
import media_manager.database
from media_manager.config import MediaManagerConfig
from media_manager.movies.service import (
auto_download_all_approved_movie_requests,
import_all_movie_torrents,
@@ -15,7 +16,7 @@ from media_manager.tv.service import (
)
def setup_scheduler(config):
def setup_scheduler(config: MediaManagerConfig) -> BackgroundScheduler:
from media_manager.database import init_engine
init_engine(config.database)

View File

@@ -1,8 +1,7 @@
from pydantic_settings import BaseSettings, SettingsConfigDict
from pydantic_settings import BaseSettings
class QbittorrentConfig(BaseSettings):
model_config = SettingsConfigDict(env_prefix="QBITTORRENT_")
host: str = "localhost"
port: int = 8080
username: str = "admin"
@@ -14,7 +13,6 @@ class QbittorrentConfig(BaseSettings):
class TransmissionConfig(BaseSettings):
model_config = SettingsConfigDict(env_prefix="TRANSMISSION_")
path: str = "/transmission/rpc"
https_enabled: bool = True
host: str = "localhost"
@@ -25,7 +23,6 @@ class TransmissionConfig(BaseSettings):
class SabnzbdConfig(BaseSettings):
model_config = SettingsConfigDict(env_prefix="SABNZBD_")
host: str = "localhost"
port: int = 8080
api_key: str = ""

Some files were not shown because too many files have changed in this diff Show More