Skip to content

Chore: Mise à jour du README.md pour la version 0.2.0 #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AnthonyGuillauma merged 2 commits into from
Apr 6, 2025
Merged

Chore: Mise à jour du README.md pour la version 0.2.0 #50

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d1aff4
Chore: Mise à jour du README.md
AnthonyGuillauma Apr 6, 2025
4c3fbf5
Chore: Correctifs mineurs sur le README.md
AnthonyGuillauma Apr 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Bienvenue dans le monde de LogBuster, l'outil ultime pour analyser, décortiquer

- 📄 Parsing avancé de logs Apache.
- 📉 Extraire des statistiques clés.
- 🥧 Génération de graphiques camemberts.
- 🧽 Filtrer les analyses.
- 🗂️ Ranger les données par catégorie.
- 🧹 Indiquer les erreurs de format avec précision.
- 🚚 Exporter les données en JSON.
Expand All @@ -39,7 +41,7 @@ Bienvenue dans le monde de LogBuster, l'outil ultime pour analyser, décortiquer
git clone https://github.com/AnthonyGuillauma/code_source
cd code_source
python -m venv .venv
source .venv/bin/activate # Activation de l'environnement virtuel sous Bash
source .venv/bin/activate
pip install -r requirements.txt
```

Expand All @@ -48,17 +50,20 @@ pip install -r requirements.txt
git clone https://github.com/AnthonyGuillauma/code_source
cd code_source
python -m venv .venv
.venv\Scripts\activate # Activation de l'environnement virtuel sous Windows
.venv\Scripts\activate
pip install -r requirements.txt
```

## 🛠️ Utilisation de base

```
python app/main.py chemin_log [-s SORTIE]
python app/main.py chemin_log [-s SORTIE] [-i IP] [-c CODE_STATUT_HTTP] [--camembert CAMEMBERT]
```
- `chemin_log` : Le chemin vers le fichier de log Apache à analyser.
- `-s SORTIE` (optionnel) : Le chemin où sauvegarder les résultats de l'analyse. Si non spécifié, les résultats seront sauvegardés dans un fichier `analyse-log-apache.json`.
- `-i IP` (optionnel) : Le filtre à appliquer sur les adresses IP des entrées du fichier de log. Uniquement les entrées avec cette adresse IP seront analysées.
- `-c CODE_STATUT_HTTP` (optionnel) : Le filtre à appliquer sur les code de statut http des entrées du fichier de log. Uniquement les entrées avec ce code de statut http seront analysées.
- `--camembert CAMEMBERT` (optionnel) : Active la génération de graphiques camemberts dans lors de l'analyse pour les statistiques compatibles (plus d'infos [ici](https://anthonyguillauma.github.io/code_source/#d-utilisation)).

## ⚠️ Précautions

Expand Down