Add initial project documentation and gitignore
- Add comprehensive README.md explaining AnimeLibrarian features and usage - Add .gitignore with Python exclusions and .crush file - Document Linux-specific requirements and local file processing 💘 Generated with Crush Assisted-by: GLM-4.6 via Crush <crush@charm.land>
This commit is contained in:
70
README.md
Normal file
70
README.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# AnimeLibrarian
|
||||
|
||||
AnimeLibrarian est un outil en ligne de commande conçu pour organiser et vérifier vos collections d'anime sur des serveurs Emby sous Linux. Il utilise l'API [trace.moe](https://trace.moe/) pour analyser directement les fichiers sur le serveur et garantir un classement précis.
|
||||
|
||||
## Fonctionnalités
|
||||
|
||||
- **Analyse de dossier local**: Analyse directement les fichiers sur le serveur (ex: `/mnt/emby`)
|
||||
- **Sélection de séries**: Choisissez les séries à traiter dans votre collection
|
||||
- **Vérification des épisodes**: Utilise trace.moe pour vérifier le bon numéro d'épisode
|
||||
- **Contrôle d'intégrité**: Vérifie que les épisodes sont entiers et complets
|
||||
- **Renommage automatique**: Renomme correctement les fichiers si nécessaire
|
||||
- **Interface terminal**: Utilisation entièrement en ligne de commande
|
||||
|
||||
## Prérequis
|
||||
|
||||
- Linux (Ubuntu/Debian, CentOS, etc.)
|
||||
- Python 3.7 ou supérieur
|
||||
- Accès direct aux fichiers des séries sur le serveur
|
||||
- Une connexion internet pour l'API trace.moe
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
git clone https://github.com/votre-username/AnimeLibrarian.git
|
||||
cd AnimeLibrarian
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Utilisation
|
||||
|
||||
Lancez le programme et sélectionnez votre dossier de séries :
|
||||
|
||||
```bash
|
||||
python main.py
|
||||
```
|
||||
|
||||
Suivez les instructions pour :
|
||||
1. Sélectionner le dossier contenant vos séries (ex: `/mnt/emby`)
|
||||
2. Choisir les séries à traiter
|
||||
3. Valider les actions à effectuer
|
||||
|
||||
## Exemple d'utilisation
|
||||
|
||||
```bash
|
||||
$ python main.py
|
||||
Sélectionnez le dossier contenant vos séries anime: /mnt/emby
|
||||
Séries trouvées:
|
||||
1. One Piece
|
||||
2. Attack on Titan
|
||||
3. My Hero Academia
|
||||
|
||||
Choisissez les séries à traiter (ex: 1,3): 1,3
|
||||
Vérifier les numéros d'épisode? (o/n): o
|
||||
Vérifier l'intégrité des fichiers? (o/n): o
|
||||
Renommer les fichiers si nécessaire? (o/n): o
|
||||
|
||||
Traitement en cours...
|
||||
```
|
||||
|
||||
## API trace.moe
|
||||
|
||||
Ce projet utilise l'API trace.moe pour identifier les scènes d'anime et vérifier les épisodes. Pour plus d'informations sur l'API, visitez [https://trace.moe/](https://trace.moe/).
|
||||
|
||||
## Contribuer
|
||||
|
||||
Les contributions sont les bienvenues ! N'hésitez pas à ouvrir une issue ou à soumettre une pull request.
|
||||
|
||||
## Licence
|
||||
|
||||
Ce projet est sous licence MIT.
|
||||
Reference in New Issue
Block a user