FiestaTheNewbieDev / empaktor

EMPAKTOR

Sommaire

1. Installations
   • Installations classiques
   • Installations développeurs
2. Utilisation
   • Compression
   • Décompression
3. Empaktor
4. Algorithmes de compression utilisés
   • Run-Length Encoding
   • Burrows-Wheeler Transform
   • Huffman Encoding
5. Auteurs

Installations

Pour ce projet, plusieurs configurations d'installation existent: la configuration classique permet d'installer les composants nécessaires au fonctionnement du programme, tandis que la configuration développeurs installe les outils nécessaires au développement du programme.

Installations classiques

Pour effectuer les installations classiques, vous devez éxécuter la commande suivante:

bash build.sh

Celle-ci installe python3 et pip3.

Installations développeurs

Pour effectuer les installations développeurs, vous devez éxécuter la commande suivante:

bash build.sh --dev

Celle-ci installe pycodestyle et pylint en supplément.

Utilisation

Compression

python3 empaktor.py [nom_archive] --compression [algo_compression] [nom(s)_fichier(s)]

• Paramètres:
  • nom_archive: Nom de la future archive, doit contenir l'extension .tar.gz
  • algo_compression: Algorithme de compression à utiliser (rle, burrows_wheeler, huffman)
  • nom(s)_fichier(s): Nom d'un ou plusieurs fichiers à inclure dans l'archive
• Sortie: Archive du nom de [nom_archive]
• Exemple:
  • Arborescence initiale:

  |-- empaktor/
  |   |-- empaktor.py
  |   |-- ...
  |-- dossier1/
  |   |-- ...
  |-- fichier1
  |-- fichier2
  |-- ...  
  

  • Commande:

  python3 empaktor/empaktor.py mon_archive.tar.gz --compression rle fichier1 dossier1 fichier2

  • Arboresence après éxécution:

  |-- empaktor/
  |   |-- empaktor.py
  |   |-- ...
  |-- dossier1/
  |   |-- ...
  |-- fichier1
  |-- fichier2
  |-- mon_archive.tar.gz
  |-- ...  
  

Décompression

python3 empaktor.py --extract [nom_archive]

• Paramètres:
  • nom_archive: Nom de l'archive ayant l'extension tar.gz à décompresser
• Sortie: Dossier ayant le nom de l'archive
• Exemple:
  • Arborescence initiale:

  |-- empaktor/
  |   |-- empaktor.py
  |   |-- ...
  |-- dossier1/
  |   |-- ...
  |-- fichier1
  |-- fichier2
  |-- mon_archive.tar.gz
  |-- ...  
  

  • Commande:

  python3 empaktor/empaktor.py --extract mon_archive.tar.gz 

  • Arboresence après éxécution:

  |-- empaktor/
  |   |-- empaktor.py
  |   |-- ...
  |-- mon_archive/
  |   |-- dossier1/
  |   |   |-- ...
  |   |-- fichier1
  |   |-- fichier2
  |-- dossier1/
  |   |-- ...
  |-- fichier1
  |-- fichier2
  |-- mon_archive.tar.gz
  |-- ...  
  

Empaktor

Documentation de empaktor.py ici.

Algorithmes de compression utilisés

Documentation de chacun des algorithmes de compression utilisés:

• Run-Length Encoding
• Burrows-Wheeler Transform
• Huffman Encoding

Auteurs

Clément FOSSORIER & Olivier VO