magazarr 0.1.0__tar.gz

magazarr-0.1.0/.github/workflows/PullRequests.yml

@@ -0,0 +1,70 @@
+name: Pull Requests
+
+on:
+  workflow_dispatch:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  quality-check:
+    name: Check
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Run checks
+        run: |
+          uv sync --group dev
+          uv run pre-commit.py --ci
+
+  build-wheel:
+    name: Build Wheel
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    needs: quality-check
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Build wheel
+        run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel
+          path: ./dist/*
+
+  docker-smoke:
+    name: Docker Build Smoke
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: build-wheel
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/download-artifact@v4
+        with:
+          name: wheel
+          path: ./docker/dist
+      - uses: docker/setup-buildx-action@v3
+      - name: Build image
+        uses: docker/build-push-action@v6
+        with:
+          context: ./docker
+          platforms: linux/amd64
+          push: false
+          load: true
+          tags: magazarr:ci

magazarr-0.1.0/.github/workflows/Release.yml

@@ -0,0 +1,252 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      skip_pypi:
+        default: false
+        description: "Skip PyPI upload"
+        type: boolean
+  push:
+    paths-ignore:
+      - ".github/**"
+      - "docker/**"
+    branches:
+      - main
+
+env:
+  PACKAGE_NAME: magazarr
+  GHCR_ENDPOINT: ghcr.io/${{ github.repository_owner }}/magazarr
+  DOCKERHUB_ENDPOINT: ${{ github.repository_owner }}/docker-magazarr
+  DESCRIPTION: "Magazarr manages magazine downloads through Quasarr and exposes OPDS."
+
+jobs:
+  version:
+    name: Get Version
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Get Version
+        id: version
+        run: |
+          VERSION=$(uv run python magazarr/version.py)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Version: $VERSION"
+
+  build-wheel:
+    name: Build Wheel
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    outputs:
+      attestation-id: ${{ steps.attest.outputs.attestation-id }}
+    permissions:
+      contents: read
+      id-token: write
+      attestations: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Run checks
+        run: |
+          uv sync --group dev
+          uv run pre-commit.py --ci
+      - name: Build wheel
+        run: uv build
+      - name: Generate artifact attestation
+        id: attest
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-path: "dist/*.whl"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel
+          path: ./dist/*
+
+  build-docker-amd64:
+    name: Build Docker (AMD64)
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: [version, build-wheel]
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/download-artifact@v4
+        with:
+          name: wheel
+          path: ./docker/dist
+      - uses: docker/setup-buildx-action@v3
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERUSER }}
+          password: ${{ secrets.DOCKERPASS }}
+      - name: Build and Push
+        uses: docker/build-push-action@v6
+        with:
+          context: ./docker
+          platforms: linux/amd64
+          push: true
+          provenance: false
+          sbom: false
+          annotations: |
+            org.opencontainers.image.description=${{ env.DESCRIPTION }}
+          tags: |
+            ${{ env.GHCR_ENDPOINT }}:latest-amd64
+            ${{ env.GHCR_ENDPOINT }}:${{ needs.version.outputs.version }}-amd64
+            ${{ env.DOCKERHUB_ENDPOINT }}:latest-amd64
+            ${{ env.DOCKERHUB_ENDPOINT }}:${{ needs.version.outputs.version }}-amd64
+          cache-from: type=gha,scope=amd64
+          cache-to: type=gha,mode=max,scope=amd64
+
+  build-docker-arm64:
+    name: Build Docker (ARM64)
+    runs-on: ubuntu-24.04-arm
+    timeout-minutes: 5
+    needs: [version, build-wheel]
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/download-artifact@v4
+        with:
+          name: wheel
+          path: ./docker/dist
+      - uses: docker/setup-buildx-action@v3
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERUSER }}
+          password: ${{ secrets.DOCKERPASS }}
+      - name: Build and Push
+        uses: docker/build-push-action@v6
+        with:
+          context: ./docker
+          platforms: linux/arm64
+          push: true
+          provenance: false
+          sbom: false
+          annotations: |
+            org.opencontainers.image.description=${{ env.DESCRIPTION }}
+          tags: |
+            ${{ env.GHCR_ENDPOINT }}:latest-arm64
+            ${{ env.GHCR_ENDPOINT }}:${{ needs.version.outputs.version }}-arm64
+            ${{ env.DOCKERHUB_ENDPOINT }}:latest-arm64
+            ${{ env.DOCKERHUB_ENDPOINT }}:${{ needs.version.outputs.version }}-arm64
+          cache-from: type=gha,scope=arm64
+          cache-to: type=gha,mode=max,scope=arm64
+
+  merge-docker-manifest:
+    name: Merge Docker Manifests
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    needs: [version, build-docker-amd64, build-docker-arm64]
+    permissions:
+      packages: write
+    steps:
+      - uses: docker/setup-buildx-action@v3
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERUSER }}
+          password: ${{ secrets.DOCKERPASS }}
+      - name: Create and Push Manifests
+        run: |
+          TAG_AMD64="${{ needs.version.outputs.version }}-amd64"
+          TAG_ARM64="${{ needs.version.outputs.version }}-arm64"
+          ANNOTATION="index:org.opencontainers.image.description=$DESCRIPTION"
+          docker buildx imagetools create -t ${{ env.GHCR_ENDPOINT }}:latest --annotation "$ANNOTATION" ${{ env.GHCR_ENDPOINT }}:latest-amd64 ${{ env.GHCR_ENDPOINT }}:latest-arm64
+          docker buildx imagetools create -t ${{ env.GHCR_ENDPOINT }}:${{ needs.version.outputs.version }} --annotation "$ANNOTATION" ${{ env.GHCR_ENDPOINT }}:${TAG_AMD64} ${{ env.GHCR_ENDPOINT }}:${TAG_ARM64}
+          docker buildx imagetools create -t ${{ env.DOCKERHUB_ENDPOINT }}:latest ${{ env.DOCKERHUB_ENDPOINT }}:latest-amd64 ${{ env.DOCKERHUB_ENDPOINT }}:latest-arm64
+          docker buildx imagetools create -t ${{ env.DOCKERHUB_ENDPOINT }}:${{ needs.version.outputs.version }} ${{ env.DOCKERHUB_ENDPOINT }}:${TAG_AMD64} ${{ env.DOCKERHUB_ENDPOINT }}:${TAG_ARM64}
+
+  release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    needs: [version, build-wheel, merge-docker-manifest]
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: actions/download-artifact@v4
+        with:
+          name: wheel
+          path: ./wheel
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Publish to PyPI
+        if: ${{ !inputs.skip_pypi }}
+        run: uv publish ./wheel/* --token ${{ secrets.PYPI_TOKEN }}
+      - name: Generate changelog
+        id: changelog
+        uses: metcalfc/changelog-generator@v4.6.2
+        with:
+          myToken: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create Release Body
+        run: |
+          echo "### Docker:" > release_body.md
+          echo "\`docker pull ${{ env.GHCR_ENDPOINT }}:latest\`" >> release_body.md
+          echo "### Python:" >> release_body.md
+          echo "\`uv tool upgrade magazarr\`" >> release_body.md
+          echo "### Changelog:" >> release_body.md
+          echo "${{ steps.changelog.outputs.changelog }}" >> release_body.md
+          echo "[Attestation](https://github.com/${{ github.repository }}/attestations/${{ needs.build-wheel.outputs.attestation-id }})" >> release_body.md
+      - name: Create Release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: "./wheel/*.whl"
+          artifactErrorsFailBuild: true
+          bodyFile: "release_body.md"
+          tag: v.${{ needs.version.outputs.version }}
+
+  job-summary:
+    name: Build Report
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    needs: [version, build-wheel, build-docker-amd64, build-docker-arm64, release]
+    if: always()
+    steps:
+      - name: Generate Job Summary
+        run: |
+          echo "## Release Production Report" >> $GITHUB_STEP_SUMMARY
+          echo "| Artifact | Status |" >> $GITHUB_STEP_SUMMARY
+          echo "| --- | --- |" >> $GITHUB_STEP_SUMMARY
+          echo "| Python Wheel | ${{ needs.build-wheel.result == 'success' && 'OK' || 'FAILED' }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| Docker AMD64 | ${{ needs.build-docker-amd64.result == 'success' && 'OK' || 'FAILED' }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| Docker ARM64 | ${{ needs.build-docker-arm64.result == 'success' && 'OK' || 'FAILED' }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| GitHub Release | ${{ needs.release.result == 'success' && 'Published' || 'FAILED' }} |" >> $GITHUB_STEP_SUMMARY

magazarr-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+.venv/
+.pytest_cache/
+.ruff_cache/
+__pycache__/
+*.py[cod]
+dist/
+docker/dist/
+
+# Local runtime and imported media. Never commit database or library content.
+/data/
+/library/
+/downloads/
+/imports/
+*.db
+*.sqlite
+*.sqlite3
+
+.DS_Store

magazarr-0.1.0/.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Magazarr",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${workspaceFolder}/Magazarr.py",
+      "console": "integratedTerminal",
+      "consoleTitle": "Magazarr",
+      "env": {
+        "PORT": "8090",
+        "LISTEN": "127.0.0.1",
+        "MAGAZARR_CONFIG_DIR": "${workspaceFolder}/data"
+      },
+      "justMyCode": true
+    }
+  ]
+}

magazarr-0.1.0/.vscode/tasks.json

@@ -0,0 +1,52 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Setup",
+      "type": "shell",
+      "command": "uv sync --group dev --group build",
+      "problemMatcher": []
+    },
+    {
+      "label": "Run Magazarr",
+      "type": "shell",
+      "command": "uv run magazarr",
+      "options": {
+        "env": {
+          "PORT": "8090",
+          "LISTEN": "127.0.0.1",
+          "MAGAZARR_CONFIG_DIR": "${workspaceFolder}/data"
+        }
+      },
+      "isBackground": true,
+      "problemMatcher": []
+    },
+    {
+      "label": "Checks",
+      "type": "shell",
+      "command": "uv run pre-commit.py --ci",
+      "group": "test",
+      "problemMatcher": []
+    },
+    {
+      "label": "Build Wheel",
+      "type": "shell",
+      "command": "uv build",
+      "group": "build",
+      "problemMatcher": []
+    },
+    {
+      "label": "Build Docker Local",
+      "type": "shell",
+      "command": "uv build && mkdir -p docker/dist && cp dist/*.whl docker/dist/ && docker build -t magazarr:local docker",
+      "group": "build",
+      "problemMatcher": []
+    },
+    {
+      "label": "Clean Generated",
+      "type": "shell",
+      "command": "rm -rf .venv .pytest_cache .ruff_cache dist docker/dist magazarr/__pycache__ tests/__pycache__",
+      "problemMatcher": []
+    }
+  ]
+}

magazarr-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 RiX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

magazarr-0.1.0/Magazarr.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+
+import multiprocessing
+
+import magazarr
+
+if __name__ == "__main__":
+    multiprocessing.freeze_support()
+    magazarr.run()

magazarr-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: magazarr
+Version: 0.1.0
+Summary: Tiny magazine manager for Quasarr with OPDS output.
+Author: RiX
+License: MIT License
+        
+        Copyright (c) 2026 RiX
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: bottle>=0.13.4
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pymupdf>=1.24.0
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: requests>=2.32.5
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="assets/magazarr-logo.png" alt="Magazarr" width="520">
+</p>
+
+Magazarr is a small magazine-only companion for Quasarr.
+
+It keeps a free-text magazine list, searches Quasarr for recent issues, sends chosen releases back to Quasarr for download, imports the largest PDF from completed JDownloader folders, and exposes the library through OPDS.
+
+Magazarr automatically searches active titles every 60 minutes by default and checks completed downloads for import every 5 minutes by default. Set either interval to `0` to disable that background task.
+
+## Run
+
+```bash
+uv run magazarr
+```
+
+Open `http://127.0.0.1:8090`.
+
+## Docker
+
+Local build:
+
+```bash
+uv build
+mkdir -p docker/dist
+cp dist/*.whl docker/dist/
+docker build -t magazarr:local docker
+```
+
+Local run:
+
+```bash
+docker run --rm \
+  -p 8090:8090 \
+  -v "$PWD/config:/config" \
+  -v "$PWD/library:/library" \
+  -v "$PWD/output:/output" \
+  magazarr:local
+```
+
+Compose template lives at `docker/docker-compose.yml`. Replace `ghcr.io/your-github-user/magazarr:latest` with your published image.
+
+## Required Settings
+
+- Quasarr URL and API key.
+- JDownloader import root. If JDownloader runs in a separate Docker container, its default completed-download path is usually `/output`. Mount the same host download volume into Magazarr at the same path and set the import root to `/output`.
+- Completed package folders reported by Quasarr must be inside the import root before Magazarr imports the PDF and deletes the completed package subfolder. If a completed PDF is directly in the import root, Magazarr deletes only that file after import and keeps the root folder.
+- Library directory for imported PDFs.
+
+## Run Quasarr Locally For Testing
+
+In a second terminal:
+
+```bash
+cd ~/PythonProjects/Quasarr
+INTERNAL_ADDRESS=http://127.0.0.1:8080 uv run quasarr
+```
+
+Use the API key printed by Quasarr in Magazarr settings:
+
+- Quasarr URL: `http://127.0.0.1:8080`
+- Search category: `7000`
+- Download category: `docs`
+
+Quasarr still needs working JDownloader credentials and at least one configured magazine-capable hostname before a real download can complete.
+
+## Quasarr Integration
+
+Magazarr uses the Quasarr Newznab/SABnzbd shim:
+
+- Search: `GET /api?t=search&q=<title>&cat=7000&apikey=<key>`
+- Download: `GET /api?mode=addurl&name=<quasarr download link>&cat=docs&apikey=<key>`
+- Import status: `GET /api?mode=history&apikey=<key>`
+
+The user agent is intentionally `lazylibrarian` because current Quasarr accepts generic document searches from that client string.
+
+## OPDS
+
+OPDS root is:
+
+```text
+http://127.0.0.1:8090/opds
+```
+
+Optional basic auth applies only to OPDS routes.
+
+Imported PDF issue entries expose a cover image link. Magazarr renders page 1 of the
+PDF as a cached PNG on first cover request.
+
+## License
+
+MIT License. Copyright (c) 2026 RiX.

magazarr-0.1.0/README.md

@@ -0,0 +1,92 @@
+<p align="center">
+  <img src="assets/magazarr-logo.png" alt="Magazarr" width="520">
+</p>
+
+Magazarr is a small magazine-only companion for Quasarr.
+
+It keeps a free-text magazine list, searches Quasarr for recent issues, sends chosen releases back to Quasarr for download, imports the largest PDF from completed JDownloader folders, and exposes the library through OPDS.
+
+Magazarr automatically searches active titles every 60 minutes by default and checks completed downloads for import every 5 minutes by default. Set either interval to `0` to disable that background task.
+
+## Run
+
+```bash
+uv run magazarr
+```
+
+Open `http://127.0.0.1:8090`.
+
+## Docker
+
+Local build:
+
+```bash
+uv build
+mkdir -p docker/dist
+cp dist/*.whl docker/dist/
+docker build -t magazarr:local docker
+```
+
+Local run:
+
+```bash
+docker run --rm \
+  -p 8090:8090 \
+  -v "$PWD/config:/config" \
+  -v "$PWD/library:/library" \
+  -v "$PWD/output:/output" \
+  magazarr:local
+```
+
+Compose template lives at `docker/docker-compose.yml`. Replace `ghcr.io/your-github-user/magazarr:latest` with your published image.
+
+## Required Settings
+
+- Quasarr URL and API key.
+- JDownloader import root. If JDownloader runs in a separate Docker container, its default completed-download path is usually `/output`. Mount the same host download volume into Magazarr at the same path and set the import root to `/output`.
+- Completed package folders reported by Quasarr must be inside the import root before Magazarr imports the PDF and deletes the completed package subfolder. If a completed PDF is directly in the import root, Magazarr deletes only that file after import and keeps the root folder.
+- Library directory for imported PDFs.
+
+## Run Quasarr Locally For Testing
+
+In a second terminal:
+
+```bash
+cd ~/PythonProjects/Quasarr
+INTERNAL_ADDRESS=http://127.0.0.1:8080 uv run quasarr
+```
+
+Use the API key printed by Quasarr in Magazarr settings:
+
+- Quasarr URL: `http://127.0.0.1:8080`
+- Search category: `7000`
+- Download category: `docs`
+
+Quasarr still needs working JDownloader credentials and at least one configured magazine-capable hostname before a real download can complete.
+
+## Quasarr Integration
+
+Magazarr uses the Quasarr Newznab/SABnzbd shim:
+
+- Search: `GET /api?t=search&q=<title>&cat=7000&apikey=<key>`
+- Download: `GET /api?mode=addurl&name=<quasarr download link>&cat=docs&apikey=<key>`
+- Import status: `GET /api?mode=history&apikey=<key>`
+
+The user agent is intentionally `lazylibrarian` because current Quasarr accepts generic document searches from that client string.
+
+## OPDS
+
+OPDS root is:
+
+```text
+http://127.0.0.1:8090/opds
+```
+
+Optional basic auth applies only to OPDS routes.
+
+Imported PDF issue entries expose a cover image link. Magazarr renders page 1 of the
+PDF as a cached PNG on first cover request.
+
+## License
+
+MIT License. Copyright (c) 2026 RiX.

magazarr-0.1.0/docker/.dockerignore

@@ -0,0 +1,2 @@
+__pycache__/
+*.pyc