BackupArr
AI Notice: NONE of the Code in this Repository has been written by AI, that being said I did use AI to partially draft this README.md. (I really suck at this stuff...)
Welcome to the BackupArr repository. This project is currently in its early development stages (Alpha) and aims to provide a lightweight, efficient way to "back up" your media library without duplicating large video files.
The Concept
Traditional backups for media libraries are often prohibitively expensive due to massive file sizes. BackupArr changes the paradigm: instead of backing up the media files themselves, this tool maps your library metadata back to its source. In the event of data loss, you can restore the library state to your download client to re-acquire the media from the swarm.
Installation
1. pipx (Recommended)
- Install with pipx, this requires pipx to be installed. See pipx wiki.
pipx install backuparr
2. pip
- Install with pip (requires a virtual environment):
pip install backuparr
First Setup
- Running First Config Setup:
This will copy the .env.example file to the .env file, and will ask for the initial values of the keys.backuparr-init
Usage
-
Changing environment variables
backuparr-configThis will allow you to change the environment variables via the cmd.
-
Command Structure:
backuparr [backup|restore] [radarr|sonarr] [filename].json
-
Example Command:
backuparr backup radarr radarr_backup.json
-
Help Command:
backuparr-help
Displays all the commands and their usages.
Contributing
We welcome all input during these early stages!
- Open an Issue to discuss new ideas or report bugs.
- Submit a Pull Request to help with early-stage logic.
- Check the Discussions tab to help define the project roadmap.
Development
-
Clone the repository:
git clone https://github.com/DanielMayhan/BackupArr.git cd BackupArr/backuparr
-
Configure Environment: Copy the sample configuration and add your Radarr & Sonarr Api Keys.
cp .env.example .env
Roadmap
These are features and code changes that are either currently being worked on or are planned to be implemented later!
- Better integration for automated Backups
License
This project is licensed under the MIT License.
1 maintainer
Metadata
1 maintainer
Release files for backuparr 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| backuparr-1.0.0.tar.gz | 10.0 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| backuparr-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.5 kB
Release files / backuparr-1.0.0.tar.gz
| Download URL | backuparr-1.0.0.tar.gz |
|---|---|
| Size | 10.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dea4a176c7fa0b303cde0ce17278714865cc26bfba9ef9d1a5b849a587ab78af
|
|
BLAKE2b-256 checksum How to use checksums |
57e2f843a8928d1ef3082b0eb1f244c91f9e46ccea021777eaf959c938859a93
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 3, 2026.
Transparency logRelease files / backuparr-1.0.0-py3-none-any.whl
| Download URL | backuparr-1.0.0-py3-none-any.whl |
|---|---|
| Size | 11.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbbb968dc9aec3d2bb2ebafdf651f55efe21329685608c229f0bf9ec83d6fd29
|
|
BLAKE2b-256 checksum How to use checksums |
c6e8a9b2f6888be3c9d4b914ccb7886a7e1e4a1a8d6964a427b2ef5d6176ca46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 3, 2026.
Transparency logSecurity for backuparr 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for backuparr-1.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 3, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
