Skip to content

Flowz5/doc_hunter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🏹 DocHunter

DocHunter est un assistant de productivité pour développeurs intégré directement à l'environnement Linux (Hyprland). Il permet de rechercher instantanément dans les documentations officielles ou de générer des "Cheat Sheets" de code sans jamais quitter le clavier ni ouvrir manuellement un navigateur.

Python Platform License


🚀 Fonctionnalités

  • ⚡ Cheat Mode (Intégration cheat.sh) : Obtenez des snippets de code instantanés (ex: tar extract, python request) directement dans le terminal avec coloration syntaxique.
  • 🔍 Recherche Live Multi-Sources : Scrape DuckDuckGo en temps réel pour agréger les résultats des documentations officielles (Python, MDN, Linux Man Pages, Docker, etc.).
  • 🪟 Fenêtre Flottante (Workflow) : S'ouvre en overlay au centre de l'écran via un raccourci clavier (Win+Shift+Space) et se ferme automatiquement après action.
  • 📋 Actions Rapides : Copie le code ou l'URL dans le presse-papier, ou ouvre le lien dans le navigateur par défaut.
  • 🎨 Interface Riche : Menu interactif avec recherche floue (Fuzzy Search) grâce à InquirerPy et affichage stylisé avec Rich.

🛠️ Stack Technique

  • Langage : Python 3
  • Scraping : Requests, BeautifulSoup4
  • CLI / UX : InquirerPy, Rich
  • Système : Pyperclip (Presse-papier), Script Bash d'automatisation.

⚙️ Installation

1. Prérequis

  • Linux (Testé sur Fedora/Arch avec Hyprland).
  • Un terminal supportant les classes (ex: Kitty, Alacritty).
  • Un gestionnaire de presse-papier Wayland (wl-clipboard).
# Sur Fedora
sudo dnf install wl-clipboard

# Sur Arch Linux
sudo pacman -S wl-clipboard

2. Cloner et Installer

git clone [https://github.com/VOTRE_USERNAME/DocHunter.git](https://github.com/VOTRE_USERNAME/DocHunter.git)
cd DocHunter

# Création de l'environnement virtuel
python3 -m venv venv
source venv/bin/activate

# Installation des dépendances
pip install -r requirements.txt

(Note : Si vous n'avez pas de fichier requirements.txt, lancez pip install requests beautifulsoup4 InquirerPy rich pyperclip)

🖥️ Configuration Hyprland

Pour que la fenêtre apparaisse en flottant au centre de l'écran, ajoutez ceci à votre fichier ~/.config/hypr/hyprland.conf :

# --- DOC HUNTER ---
# Raccourci : Win + Shift + Espace
bind = $mainMod SHIFT, SPACE, exec, kitty --class floating_doc --title "DocHunter" bash -c "cd /CHEMIN/VERS/DocHunter && source venv/bin/activate && python main.py; exit"

# Règles d'affichage (Taille, Position, Opacité)
windowrulev2 = float,class:^(floating_doc)$
windowrulev2 = center,class:^(floating_doc)$
windowrulev2 = size 900 600,class:^(floating_doc)$
windowrulev2 = stayfocused,class:^(floating_doc)$
windowrulev2 = dimaround,class:^(floating_doc)$
windowrulev2 = opacity 1.0 1.0,class:^(floating_doc)$

Pensez à adapter /CHEMIN/VERS/DocHunter avec votre vrai chemin.

📖 Utilisation

  1. Pressez Win + Shift + Espace.
  2. Choisissez une source (ex: 🐍 Python, ⚡ Cheat Sheet, 🐧 Linux).
  3. Tapez votre recherche (ex: list comprehension, useradd).
  4. Sélectionnez un résultat pour :
  • Copier le code (Mode Cheat Sheet).
  • Ouvrir la documentation dans le navigateur.
  • Copier le lien.

🤝 Contribuer

Les contributions sont les bienvenues ! Si vous souhaitez ajouter de nouvelles sources de documentation (ex: C#, Rust, AWS...), modifiez simplement le dictionnaire DOC_TARGETS dans main.py.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages