Extractarr

Introduction

extractarr is a Python-based utility designed to monitor specified directories for newly downloaded archive files and automatically extract them. It supports a variety of archive formats like .rar, .zip, .tar, .7z, and others. This tool is especially useful for automating the extraction process in scenarios like downloading TV shows, movies, music, or any other data that comes in compressed formats.

Features

Directory Monitoring: Watches specified directories for new archive files.
Supports Multiple Formats: Works with .rar, .zip, .tar, .7z, and more.
Automatic Extraction: Automatically extracts new archives into designated folders.
System Integration: Runs as a systemd service for continuous operation.

Installation

Prerequisites

Python 3.6 or higher.
System dependencies: p7zip (for Linux users).
[Optional] Virtual environment (recommended).

Setup

Clone the Repository:

git clone https://github.com/zampierilucas/extractarr.git
cd extractarr

Create and Activate a Virtual Environment (Optional):
```
python -m venv venv
source venv/bin/activate
```
Install Python Dependencies:
```
pip install -r requirements.txt
```
Build the Application:
```
make build
```
Install the Application:
```
sudo make install
```

Usage

After installation, extractarr will start monitoring the configured directories automatically. To check the status of the service:

systemctl status extractarr.service

To restart the service:

sudo systemctl restart extractarr.service

Configuration

Edit the .config/extractarr/config.yml, the settings that can be used are:

watch_directories: A list of directories that extractarr will monitor for new archive files.
exclude_extensions: A list of file extensions to exclude from processing. Files with these extensions will be ignored by extractarr.
check_interval: Time interval in seconds between each check for new files in the monitored directories.

check_interval: 5 # Time in seconds
watch_directories:
  - /path/to/first/directory
  - /path/to/second/directory

exclude_extensions:
  - .iso
  - .exe
  - .example_extension

To uninstall:

sudo make uninstall

Contributing

Contributions to extractarr are welcome! If you have a feature request, bug report, or a pull request, please open an issue or submit a PR on the repository.