Automated Development Environment
Project description
coBoarding
coBoarding to kompleksowy, kontenerowy system do automatycznego wypełniania formularzy rekrutacyjnych, kładący nacisk na prywatność, elastyczność oraz wsparcie wielojęzyczne.
Główne cechy
- Architektura oparta na Docker (moduły: browser-service, llm-orchestrator, novnc, web-interface)
- 100% lokalne przetwarzanie danych (prywatność)
- Wykrywanie sprzętu (GPU/CPU, RAM) i automatyczny dobór modelu LLM
- Wielojęzyczność (PL, DE, EN) z automatyczną detekcją
- Nowoczesny web UI z HTTPS i sterowaniem głosowym
- Automatyczna generacja pipelines dla portali pracy
- Wizualizacja procesu przez noVNC
- Integracja z menedżerami haseł (Bitwarden, PassBolt)
- Kompletne środowisko testowe
📚 Spis treści / Menu
- Szybki start
- Instalacja środowiska (Python 3.11+ / 3.12 na Ubuntu 24.10+)
- Struktura kontenerów
- Weryfikacja wdrożenia
- Scenariusze testowe
- FAQ
- Kontakt i wsparcie
Szybki start
git clone https://github.com/coboarding/coboarding.git
cd coBoarding
bash install.sh # automatyczna instalacja zależności i Docker Compose v2
bash run.sh # lub ./run.ps1 na Windows
Pierwsze uruchomienie automatycznie skonfiguruje środowisko (venv, zależności, kontenery, Docker Compose v2).
WAŻNE: Projekt wymaga Docker Compose v2 (polecenie
docker compose). Skryptinstall.shinstaluje go automatycznie jako plugin CLI.
Instalacja środowiska (Python 3.11+ / 3.12 na Ubuntu 24.10+)
Aby uniknąć problemów z kompatybilnością (np. PyAudio vs Python 3.12), zalecane jest użycie Pythona 3.11. Na Ubuntu 24.10+ dostępny jest tylko Python 3.12 – patrz uwaga poniżej!
# (Linux/Ubuntu) Instalacja wymaganych pakietów
sudo apt-get update && sudo apt-get install python3.11 python3.11-venv python3.11-dev
# Na Ubuntu 24.10+:
sudo apt-get install python3.12 python3.12-venv python3.12-dev
# Utworzenie i aktywacja środowiska wirtualnego
python3.11 -m venv venv-py311 # lub
python3.12 -m venv venv-py312 # na Ubuntu 24.10+
source venv-py311/bin/activate # lub
source venv-py312/bin/activate
# Instalacja zależności
pip install --upgrade pip
pip install -r requirements.txt
Możesz także użyć skryptu:
bash install.sh # automatyczna instalacja Docker Compose v2 (plugin CLI)
Po instalacji Compose v2 dostępne będzie jako polecenie:
docker compose version
Uwaga dot. PyAudio i Python 3.12: PyAudio nie jest kompatybilne z Python 3.12 (błąd:
pkgutil.ImpImporter).
- Jeśli nie potrzebujesz funkcji audio, możesz usunąć PyAudio z
requirements.txt.- Jeśli potrzebujesz PyAudio, spróbuj zainstalować nieoficjalny wheel z https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyaudio (tylko Windows), lub rozważ alternatywę np.
sounddevice.- Możesz też użyć środowiska z Pythonem 3.11 (np. Docker, starsze Ubuntu).
Struktura kontenerów
- browser-service: Selenium, Chrome/Firefox
- llm-orchestrator: API do analizy formularzy, wykrywanie sprzętu, zarządzanie modelami LLM (torch, transformers, langchain)
- novnc: Podgląd przeglądarki
- web-interface: React, HTTPS, Web Speech API
Weryfikacja wdrożenia
- Czy docker-compose.yml zawiera wszystkie kontenery i wolumeny?
- Czy skrypty inicjalizacyjne wykrywają sprzęt?
- Czy web-interface jest dostępny przez HTTPS?
- Czy API llm-orchestrator działa?
- Czy testy przechodzą dla przykładowych formularzy?
Scenariusze testowe
- Wypełnianie prostego i złożonego formularza
- Test wielojęzyczności
- Test podglądu przez noVNC
- Test integracji z menedżerem haseł
Dokumentacja
Szczegółowe prompty i pytania weryfikacyjne znajdziesz w pliku TODO.txt.
Kontakt i wsparcie
Projekt open-source. Wszelkie zgłoszenia błędów i propozycje zmian prosimy kierować przez Issues na GitHub.
coBoarding
System do automatycznego wypełniania formularzy internetowych wykorzystujący lokalne modele językowe (LLM) w trzech językach (polski, niemiecki, angielski) bazujący na danych z CV.
Funkcjonalności
- Automatyczne wykrywanie formularzy na stronach internetowych
- Inteligentne dopasowywanie danych z CV do pól formularza
- Obsługa trzech języków: polski, niemiecki, angielski - automatyczne wykrywanie języka formularza
- Lokalna analiza językowa z wykorzystaniem modeli LLM (bez wysyłania danych do zewnętrznych API)
- Wsparcie dla różnych formatów CV: HTML, PDF, DOCX
- Pełna automatyzacja procesu wypełniania formularzy rekrutacyjnych
- Zrzuty ekranu wypełnionych formularzy do weryfikacji
Wymagania systemowe
- Docker i Docker Compose
- Minimum 8GB RAM (zalecane 16GB)
- Minimum 10GB wolnego miejsca na dysku
- Połączenie z internetem (tylko do pobierania modeli LLM przy pierwszym uruchomieniu)
Szybki start
1. Sklonuj repozytorium
git clone https://github.com/coboarding/coboarding.git
cd coBoarding
2. Przygotuj CV
Umieść swoje CV w katalogu cv/ w jednym z obsługiwanych formatów (HTML, PDF, DOCX).
3. Utwórz plik z adresami URL
Utwórz plik urls.txt z adresami stron zawierających formularze rekrutacyjne:
https://example.com/job-application1
https://example.com/job-application2
4. Uruchom skrypt startowy
chmod +x run.sh
./run.sh
Skrypt przeprowadzi Cię przez proces uruchomienia systemu.
Szczegółowa konfiguracja
Możesz dostosować działanie systemu edytując plik config.ini:
[CV]
path = /app/cv/cv_tom_sapletta_2025_de.html
[LLM]
model_path = /app/models/mistral.gguf
model_type = llama
device = cpu
[Browser]
type = chrome
headless = true
[Output]
directory = /app/output
Dostępne modele LLM
System domyślnie używa modelu Mistral, ale możesz użyć jednego z następujących modeli:
mistral.gguf- Mistral 7B (domyślny, dobry kompromis między jakością a wymaganiami)llama-2-7b.gguf- Llama 2 7B (alternatywa)falcon-7b.gguf- Falcon 7B (alternatywa)
Większe modele (13B, 70B) zapewniają lepszą jakość, ale wymagają więcej zasobów.
Tryby działania
System można uruchomić w trzech trybach:
-
Tryb wsadowy - przetwarzanie wszystkich adresów URL z pliku:
python main.py --config config.ini --urls-file urls.txt
-
Tryb pojedynczego URL - przetwarzanie pojedynczego adresu:
python main.py --config config.ini --url https://example.com/job-application
-
Tryb interaktywny - do debugowania (tylko w Dockerze):
# W docker-compose.yml zmień command: sleep infinity docker-compose up -d docker exec -it coBoarding bash
Obsługa błędów
Typowe problemy
-
Problem: Kontener Docker kończy działanie z błędem Rozwiązanie: Sprawdź logi:
docker-compose logs -
Problem: Formularze nie są poprawnie wykrywane Rozwiązanie: Niektóre strony używają niestandardowego JavaScript. Spróbuj uruchomić w trybie nieheadless.
-
Problem: Model LLM nie jest pobierany automatycznie Rozwiązanie: Pobierz model ręcznie i umieść go w katalogu
models/
Szczegółowe logowanie i debugowanie
W plikach Dockerfile, install.sh oraz run.sh zostały dodane szczegółowe komunikaty [DEBUG] oraz [INFO].
- Każdy kluczowy etap instalacji, budowy obrazu i uruchamiania usług jest logowany.
- Logi pomagają szybko zlokalizować miejsce, gdzie wystąpił problem.
- W terminalu zobaczysz wyraźne komunikaty o postępie i ewentualnych błędach.
Wskazówka: Jeśli coś pójdzie nie tak, sprawdź logi [DEBUG] w konsoli — wskażą, na którym etapie pojawił się problem.
Jak to działa
- System analizuje CV użytkownika, parsując kluczowe informacje (doświadczenie, umiejętności, wykształcenie).
- Dla każdego URL, system uruchamia zautomatyzowaną przeglądarkę i wykrywa formularze na stronie.
- Lokalny model LLM analizuje strukturę formularza i jego pola.
- System inteligentnie dopasowuje dane z CV do pól formularza, tłumacząc je na odpowiedni język.
- Formularz jest automatycznie wypełniany, a zrzut ekranu jest zapisywany do weryfikacji.
Bezpieczeństwo
- Wszystkie dane są przetwarzane lokalnie
- Żadne informacje nie są wysyłane do zewnętrznych API
- Lokalne modele LLM zapewniają prywatność danych
- System nie wysyła automatycznie formularzy - tylko je wypełnia
Licencja
Ten projekt jest udostępniany na licencji MIT. Szczegółowe informacje można znaleźć w pliku LICENSE.
Autor
Tom Sapletta
Współpraca
Chętnie przyjmujemy Pull Requesty! Aby przyczynić się do rozwoju projektu:
- Sforkuj repozytorium
- Utwórz branch z nową funkcjonalnością (
git checkout -b feature/amazing-feature) - Zatwierdź zmiany (
git commit -m 'Add amazing feature') - Wypchnij branch (
git push origin feature/amazing-feature) - Otwórz Pull Request
Struktura projektu coBoarding
coBoarding/
├── cv/ # Katalog na pliki CV
│ └── cv_tom_sapletta_2025_de.html # Twoje CV w formacie HTML
│
├── models/ # Katalog na modele LLM
│ └── mistral.gguf # Pobrany automatycznie przy pierwszym uruchomieniu
│
├── output/ # Katalog na dane wyjściowe (zrzuty ekranu)
│
├── Dockerfile # Definicja obrazu Docker
├── docker-compose.yml # Konfiguracja Docker Compose
├── config.ini # Konfiguracja aplikacji
├── requirements.txt # Zależności Pythona
├── main.py # Główny skrypt aplikacji
├── run.sh # Skrypt do łatwego uruchamiania
├── urls.txt # Lista adresów URL do przetworzenia
└── README.md # Dokumentacja projektu
Opis plików
Główne pliki aplikacji
- main.py: Główny skrypt aplikacji zawierający całą logikę wypełniania formularzy.
- config.ini: Plik konfiguracyjny aplikacji.
- requirements.txt: Lista zależności Pythona potrzebnych do działania aplikacji.
- urls.txt: Plik z listą adresów URL stron z formularzami do wypełnienia.
- run.sh: Skrypt ułatwiający uruchamianie aplikacji.
Pliki Docker
- Dockerfile: Definicja obrazu Docker z potrzebnymi zależnościami.
- docker-compose.yml: Konfiguracja Docker Compose do łatwego uruchamiania aplikacji.
Katalogi danych
- cv/: Katalog zawierający pliki CV, z których aplikacja będzie czerpać dane do wypełniania formularzy.
- models/: Katalog zawierający modele LLM używane do analizy formularzy i generowania odpowiedzi.
- output/: Katalog przechowujący zrzuty ekranu wypełnionych formularzy.
Kluczowe funkcjonalności
Aplikacja działa w następujący sposób:
- Parsuje CV użytkownika, aby wydobyć kluczowe informacje.
- Otwiera stronę internetową z formularzem w zautomatyzowanej przeglądarce.
- Analizuje formularz za pomocą lokalnego modelu językowego (LLM).
- Dopasowuje dane z CV do pól formularza, automatycznie tłumacząc je na odpowiedni język (polski, niemiecki, angielski).
- Wypełnia formularz i wykonuje zrzut ekranu.
Całość działa w kontenerze Docker, co zapewnia łatwą instalację i uruchomienie na różnych systemach operacyjnych.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file coboarding-0.1.14.tar.gz.
File metadata
- Download URL: coboarding-0.1.14.tar.gz
- Upload date:
- Size: 6.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db5a7ff9d0842d20fd9eb8e402999431bf9e39627d91a5255a2bcae92b3b587e
|
|
| MD5 |
ee257f15f2aa1d32f76d42074e40906b
|
|
| BLAKE2b-256 |
396431c997b1b8cbb5ee54cef3944ce4a7e5f5b580d91b79dbef09b6fc570587
|
File details
Details for the file coboarding-0.1.14-py3-none-any.whl.
File metadata
- Download URL: coboarding-0.1.14-py3-none-any.whl
- Upload date:
- Size: 6.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9632e021308111d9754b0611def82fea5d56789f57da1d6fa35e739cc3dbebca
|
|
| MD5 |
96340b7ce3ee6e9545842b07f68df420
|
|
| BLAKE2b-256 |
dfdc98a658120e4dacbdb272fb8b44877976284da6afa50a1b6ac656ba9c907c
|