Metadata-Version: 2.4
Name: backuparr
Version: 0.2.0
Summary: A lightweight, efficient way to backup your media library without duplicating large video files.
Author: Daniel Mayhan
License: MIT License
        
        Copyright (c) 2026 DanielMayhan
        
        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.
        
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: python-dotenv
Dynamic: license-file

# BackupArr

---

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.

---

## Project Status: Alpha
**Warning:** This software is experimental and **Work in Progress**. It is not recommended for production use. Any and all code is subject to radical changes as development progresses.

---

## Installation

### --- Via File ---
1. Get the newest **.whl** file  release from [Releases](https://github.com/DanielMayhan/BackupArr/releases)

2. Installing the **.whl** file via pip:
    ```
    pip install /directory/of/file/backuparr-[version].whl
    ```
   
### --- Via [pip](https://pypi.org/project/backuparr/) ---

* Install with pip (no local file needed):
    ```
    pip install /directory/of/file/backuparr-[version].whl
    ```

---

## First Setup

* **Running First Config Setup:**
    ```
    backuparr-init
    ```
    This will copy the .env.example file to the .env file, and will ask for the initial values of the keys.

---

## Usage

* **Changing environment variables**
    ```
    backuparr-config
    ```
   This will allow you to change the environment variables via the cmd.


* **Command Structure:**
    ```bash
    backuparr [backup|restore] [radarr|sonarr] [filename].json
* **Example Command:**
    ```bash
    backuparr backup radarr radarr_backup.json
    ```

---

## Roadmap
These are features and code changes that are either currently being worked on or are planned to be implemented later!
* Unification of all text in-/outputs


---

## Development

1.  **Clone the repository:**
    ```bash
    git clone https://github.com/DanielMayhan/BackupArr.git
    cd BackupArr/backuparr
    ```

2.  **Configure Environment:**
    Copy the sample configuration and add your Radarr & Sonarr Api Keys.
    ```bash
    cp .env.example .env
    ```
    
---

## 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.

---

## License
This project is licensed under the [MIT License](LICENSE).
