Elie243 added a comment.

  Guide utilisateur Archiving Bot
  
  Introduction
  
  Archiving Bot est un outil conçu pour automatisiser l'archivage des URLs 
trouvées dans Wikidata. Ce guide vous aidera à comprendre, installer et 
utiliser le bot efficacement.
  
  Installation
  
  Prérequis système
  – Système d'exploitation : Windows, macOS ou Linux.
  – Python 3.7 ou supérieur
  – Git (pour cloner le dépôt)
  – Accès Internet stable.
  – Espace disque : minimum 4 GB recommandé.
  
  Étapes d'installation
  
  1. Cloner le dépôt ```bash git https://github.com/paulbouaffou/archiving-bot 
cd Archiving-bot ```
  
  2. Créer un environnement virtuel (recommandé) ```bash python -m venv venv
    1. Sur Windows venv\Scripts\activate
    2. Sur macOS/Linux source venv/bin/activate ```
  
  3. Installer les dépendances ```bash pip install -r requirements.txt ```
  
  4. Configuration initiale – Créer un compte Wikidata si nécessaire.
  
  – Configurer les fichiers de configuration.
  
  Configuration
  
  Configuration de Wikidata
  
  1. Créer un compte Wikidata
  
  – Allez sur Wikidata. <https://www.wikidata.org>
  
    – Créez un compte si vous n'en avez pas.
    – Notez vos identifiants.
  
  2. Configurer user-config.py ```python family = 'wikidata' mylang = 
'wikidata' usernames['wikidata']['wikidata'] = 'VotreNomUtilisateur' 
password_file = 'user-password.py' ```
  
  3. Configurer user-password.py ```python ('wikidata', 'wikidata', 
'VotreNomUtilisateur', 'VotreMotDePasse') ```
  
  Configuration du bot
  
  Dans `config.py`, vous pouvez personnaliser :
  
    # Nombre de changements à traiter par lot
    BATCH_SIZE = 50
    
    # Temps d'attente entre les lots (en secondes)
    SLEEP_TIME = 60
    
    # Nombre maximum de tentatives d'archivage
    MAX_RETRIES = 3
    
    # Délai entre les tentatives (en secondes)
    RETRY_DELAY = 5
  
  Utilisation
  
  Démarrage du bot
  
  1. Activer l'environnement virtuel ```bash
    1. Sur Windows venv\Scripts\activate
    2. Sur macOS/Linux source venv/bin/activate ```
  
  2. Lancer le bot ```bash python bot.py ```
  
  Surveillance du bot
  
  Le bot affiche plusieurs types d'informations :
  – INFO : Informations générales sur le fonctionnement
  – WARNING : Avertissements non critiques
  – ERROR : Erreurs nécessitant une attention
  
  Exemple de logs :
  
    2024-02-20 10:15:30 - INFO - Démarrage du bot
    2024-02-20 10:15:31 - INFO - Connexion à Wikidata établie
    2024-02-20 10:15:32 - INFO - URL détectée : https://example.com
    2024-02-20 10:15:33 - INFO - Archivage réussi
  
  Arrêt du bot
  
  1. Arrêt propre — Appuyez sur Ctrl+C.
  
  – Attendez le message de confirmation.
  
  2. Arrêt forcé — Appuyez sur Ctrl+C deux fois. – Le bot s'arrêtera 
immédiatement.
  
  Dépannage
  
  Problèmes courants
  
  1. Erreur de connexion Wikidata
  
  – Vérifiez vos identifiants dans `⁣`.
  
    – Assurez-vous que votre compte a les permissions nécessaires.
  
  – Vérifiez votre connexion Internet.
  
  2. Échec d'archivage – Vérifiez la validité de l'URL.
  
  – Assurez-vous que l'URL est accessible.
  
    – Vérifiez les limites de l'API Internet Archive.
  
  3. Erreurs de base de données
  
  – Vérifiez les permissions du dossier.
  – Assurez-vous d'avoir assez d'espace disque.
  – Vérifiez l'intégrité de la base de données.
  
  Solutions
  
  1. Réinitialisation de la base de données ```bash
    1. Sauvegardez d'abord la base existante cp archives.db archives.db.backup
    2. Supprimez la base corrompue rm archives.db
    3. Le bot créera une nouvelle base au prochain démarrage ```
  
  2. Vérification des logs – Les logs sont stockés dans la console.
  
  – Utilisez la redirection pour sauvegarder les logs :
  
    bash
         python bot.py > bot.log 2>&1
         
  
  Bonnes pratiques
  
  1. Maintenance régulière
  
  – Vérifiez régulièrement les logs.
  – Sauvegardez la base de données.
  
    – Mettez à jour les dépendances.
  
  2. Sécurité
  
  – Ne partagez pas vos identifiants.
  
    – Changez régulièrement votre mot de passe.
  
  – Gardez vos fichiers de configuration sécurisés.
  
  3. Performance – Ajustez `BATCH_SIZE` selon vos besoins. – Surveillez 
l'utilisation de la mémoire.
  
  – Vérifiez l'espace disque régulièrement.
  
  Support
  
  Pour obtenir de l'aide :
  
  1. Consultez la documentation technique.
  2. Vérifiez les issues existantes sur GitHub.
  3. Créez une nouvelle issue si nécessaire.
  4. Contactez les mainteneurs du projet.

TASK DETAIL
  https://phabricator.wikimedia.org/T390358

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Pabloawiki, Elie243
Cc: Elie243, Pabloawiki, Eti229, Wisdom-Hassan, Aklapper, pywikibot-bugs-list, 
Paul26, mevo, Danny_Benjafield_WMDE, S8321414, Astuthiodit_1, karapayneWMDE, 
Invadibot, PotsdamLamb, Jyoo1011, maantietaja, JohnsonLee01, SHEKH, Dijkstra, 
Khutuck, Nintendofan885, Akuckartz, Zkhalido, Aram, Viztor, Nandana, Wenyi, 
Lahi, Gq86, GoranSMilovanovic, QZanden, Tbscho, KimKelting, MayS, LawExplorer, 
Mdupont, JJMC89, Dvorapa, _jensen, rosalieper, Altostratus, Avicennasis, 
Hannolans, Scott_WUaS, mys_721tx, Wikidata-bugs, Xqt, Hydriz, aude, jayvdb, 
Nemo_bis, Lydia_Pintscher, Masti, Alchimista, Mbch331
_______________________________________________
pywikibot-bugs mailing list -- [email protected]
To unsubscribe send an email to [email protected]

Reply via email to