file-organizer/README.md
2024-12-08 05:53:12 +01:00

29 lines
1.3 KiB
Markdown

# file-organizer
This is a custom made software to perform maintenance on downloaded files for DarkBird's anime website.
# System Overview
![System Overview](docs/overview.png)
The application consist of a simple API with a single endpoint which starts a job and returns its ID. Then the job is orchestrated on a different thread following these steps:
1. Filtering:\
Fetch from the qbittorrent API the files that are currently being downloaded in order to filter them out of the process.
2. Deduplication:\
Invoke a [Czkawka](https://github.com/qarmin/czkawka) process to identify duplicate files, keep the appropiate version for each episode.
3. Moving:\
Using regex, identify the directory where each file should be located, and the new name it should have.
4. Log storage:\
Store all the logs for the current job in order to be able to debug and keep trazability of the process.
# Roadmap:
- [x] Be able to move and rename files based on a regex
- [x] Read qbittorrent credentials from .env file
- [x] Implement API endpoint using FastAPI
- [x] Run organization job on a separate thread
- [x] Deduplicate files using Czkawka
- [ ] Add unit tests
- [ ] Add logging
- [ ] Make it run in docker
- [ ] Create another endpoint to retrieve the logs of a job