gollm

goLLM Logo

goLLM - Go Learn, Lead, Master!

PyPI Version Python Version License Code Style: Black Tests Documentation

Dlaczego goLLM? - Bo wierzymy, że jakość kodu to nie luksus, a standard. goLLM to więcej niż narzędzie - to twój asystent w dążeniu do doskonałości programistycznej.

🚀 O projekcie

goLLM to zaawansowany system kontroli jakości kodu Python zintegrowany z modelami językowymi (LLM), który przekształca proces programowania w płynne doświadczenie, gdzie jakość kodu jest gwarantowana od pierwszego znaku.

📚 Dokumentacja

Pełna dokumentacja dostępna jest w języku angielskim:

💫 Najważniejsze funkcje

⚡ Szybki start

Local Installation

# Install with LLM support
pip install gollm[llm]

# Generate code
gollm generate "Napisz funkcję w Pythonie, która oblicza silnię"

🐳 Docker-based Development & Testing

goLLM provides a Docker-based development and testing environment to ensure consistent results across different systems. The environment includes:

Prerequisites

Quick Start

  1. Start the development environment: 
    # Build and start the containers
make docker-up
   
# This will:
# 1. Build the test environment
# 2. Start Ollama service
# 3. Pull the tinyllama model (only on first run)
# 4. Run all tests
  2. Run specific tests: 
    # Run all tests
make docker-test
   
# Run a specific test file
make docker-test TEST=tests/e2e/test_ollama.py
   
# Run tests with coverage
make docker-test-cov
  3. Development workflow: 
    # Open a shell in the test environment
make docker-shell
   
# Run linters and formatters
make docker-lint
make docker-format
   
# View logs
make docker-logs
  4. Clean up: 
    # Stop and remove containers
make docker-down
   
# Remove all containers, volumes, and images
make docker-clean

Available Make Commands

Command Description
make docker-up Start all services and run tests
make docker-down Stop and remove all containers
make docker-test Run all tests
make docker-test-cov Run tests with coverage report
make docker-lint Run linters
make docker-format Format code using black and isort
make docker-shell Open a shell in the test environment
make docker-logs View container logs
make docker-clean Remove all containers, volumes, and images

Running Make Directly

You can also run make commands directly in the container:

# Run a single make target
docker-compose run --rm testenv make test

# Or open an interactive shell and run multiple commands
docker-compose run --rm testenv bash
# Inside container:
# $ make lint
# $ make test
# $ exit

Environment Variables

You can customize the environment using these variables:

Example:

GOLLM_MODEL=tinyllama:latest make docker-test

Persistent Storage

Local Development

For local development, you can mount your local directory into the container:

docker-compose run --rm -v $(pwd):/app testenv bash

This will give you a shell where you can run any development commands, and your changes will be reflected in real-time.

Troubleshooting

  1. Model not found: 
    # Manually pull the model
docker-compose exec ollama ollama pull tinyllama
  2. Port conflicts:
    • Edit docker-compose.yml to change the host port (11435 by default)
  3. Out of disk space: 
    # Clean up unused containers and images
docker system prune -a
   
# Remove the Ollama volume (warning: will delete downloaded models)
docker volume rm gollm_ollama_data
  4. View logs: 
    # View all logs
make docker-logs
   
# View logs for a specific service
docker-compose logs -f ollama

Advanced Usage

Running Specific Tests

# Run a specific test file
docker-compose run --rm testenv pytest tests/e2e/test_ollama.py -v

# Run a specific test function
docker-compose run --rm testenv pytest tests/e2e/test_ollama.py::test_ollama_code_generation -v

# Run with coverage
docker-compose run --rm testenv pytest --cov=src/gollm tests/

Debugging

# Start containers without running tests
docker-compose up -d

# Attach to the test environment
docker-compose exec testenv bash

# Run tests with debug output
pytest -v --log-level=DEBUG

Custom Configuration

Create a .env file to override default settings:

# .env
OLLAMA_HOST=http://ollama:11434
GOLLM_MODEL=tinyllama:latest
GOLLM_TEST_TIMEOUT=30

Then run:

docker-compose --env-file .env up

Production Deployment

For production use, consider:

  1. Using a more powerful model than tinyllama
  2. Setting appropriate resource limits in docker-compose.yml
  3. Configuring proper logging and monitoring
  4. Setting up CI/CD for automated testing

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests: make docker-test
  5. Submit a pull request

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Acknowledgments

For more information, please visit our documentation.

For a consistent development and testing environment, you can use Docker:

  1. Initialize the test environment (pulls Ollama and required models): 
    ./scripts/init_test_env.sh
  2. Run all tests in Docker: 
    make docker-test
  3. Open a shell in the development container: 
    make docker-shell
  4. Clean up when done: 
    make docker-clean

This will set up a complete environment with:

⚙️ Użycie z parametrami (Usage with Parameters)

gollm oferuje szereg parametrów, które pozwalają dostosować proces generowania kodu do Twoich potrzeb.

Podstawowe parametry generowania

Kontrola testów

Automatyczne uzupełnianie i poprawki

Konfiguracja modelu LLM

Inne przydatne parametry

Aby zobaczyć pełną listę dostępnych opcji, użyj polecenia:

gollm generate --help

🤝 Współtworzenie

Zapraszamy do współtworzenia projektu! Szczegóły znajdziesz w przewodniku dla współtwórców.

📝 Licencja

Ten projekt jest dostępny na licencji Apache 2.0 - szczegóły w pliku LICENSE.

🔗 Przydatne linki

🧪 Testing

goLLM includes a comprehensive test suite to ensure code quality and functionality. Here are the available testing commands:

Basic Testing

# Run all tests
make test

# Run tests with coverage report
make test-coverage

# Run end-to-end tests (requires Ollama service)
make test-e2e

# Run health checks
make test-health

Advanced Testing Options

# Run all tests including slow ones
make test-all

# Run streaming tests (requires modular adapter)
make test-streaming

# Run tests in Docker container
make docker-test

# Open shell in test environment
make docker-shell

Infrastructure for Testing

# Start test infrastructure (Ollama service)
make infra-start

# Stop test infrastructure
make infra-stop

# Deploy test infrastructure using Ansible
make infra-deploy

Code Quality

# Run linters
make lint

# Format code
make format

# Run self-validation
make gollm-check

Cleanup

# Clean build artifacts
make clean

# Clean Docker resources
make docker-clean

🤖 Wsparcie dla modeli

goLLM wspiera różne modele językowe, w tym:

📦 Wymagania systemowe

🌍 Wsparcie społeczności

Dołącz do naszej społeczności, aby zadawać pytania i dzielić się swoimi doświadczeniami:

🔄 Ostatnie zmiany

Sprawdź historię zmian, aby zobaczyć najnowsze aktualizacje i nowe funkcje.

📚 Dokumentacja

Pełna dokumentacja dostępna jest w dokumentacji online.

📖 Przewodniki

🛠️ API

🛠️ Rozwój

Konfiguracja środowiska deweloperskiego

  1. Sklonuj repozytorium: 
    git clone https://github.com/wronai/gollm.git
cd gollm
  2. Utwórz i aktywuj środowisko wirtualne: 
    python -m venv venv
source venv/bin/activate  # Linux/MacOS
# lub
.\venv\Scripts\activate  # Windows
  3. Zainstaluj zależności deweloperskie: 
    pip install -e .[dev]

Uruchamianie testów

# Uruchom wszystkie testy
pytest

# Uruchom testy z pokryciem kodu
pytest --cov=src tests/

# Wygeneruj raport HTML z pokryciem
pytest --cov=src --cov-report=html tests/

🤝 Współpraca

Wszelkie wkłady są mile widziane! Zobacz przewodnik dla współpracowników, aby dowiedzieć się, jak możesz pomóc w rozwoju projektu.

📄 Licencja

Projekt jest dostępny na licencji Apache 2.0.


## 📊 Korzyści z używania goLLM

### Dla programistów
- **Oszczędność czasu** - Automatyczne poprawki i sugestie
- **Nauka najlepszych praktyk** - Natychmiastowy feedback jakości kodu
- **Mniejsze obciążenie code review** - Mniej błędów trafia do recenzji

### Dla zespołów
- **Spójność kodu** - Jednolite standardy w całym projekcie
- **Łatwiejsze wdrażanie nowych członków** - Automatyczne egzekwowanie standardów
- **Lepsza jakość kodu** - Systematyczne eliminowanie antywzorców

### Dla firmy
- **Niższe koszty utrzymania** - Lepsza jakość kodu = mniej bugów
- **Szybsze wdrażanie** - Zautomatyzowane procesy kontroli jakości
- **Większa wydajność zespołu** - Mniej czasu na poprawki, więcej na rozwój

## 🔄 Jak to działa?

goLLM działa w oparciu o zaawansowany system analizy kodu, który łączy w sobie:

1. **Statyczną analizę kodu** - Wykrywanie potencjalnych błędów i antywzorców
2. **Dynamiczną analizę** - Śledzenie wykonania kodu w czasie rzeczywistym
3. **Integrację z LLM** - Kontekstowe sugestie i automatyzacja zadań
4. **Automatyczne raportowanie** - Kompleksowe metryki jakości kodu

### Przykładowy workflow

```mermaid
graph TD
    A[Nowy kod] --> B{Analiza goLLM}
    B -->|Błędy| C[Automatyczne poprawki]
    B -->|Ostrzeżenia| D[Sugestie ulepszeń]
    B -->|Krytyczne| E[Blokada zapisu]
    C --> F[Ponowna analiza]
    D --> G[Recenzja programisty]
    F -->|OK| H[Zatwierdź zmiany]
    G -->|Zaakceptowano| H
    H --> I[Aktualizacja CHANGELOG]
    I --> J[Integracja z systemem CI/CD]

⚙️ Konfiguracja

goLLM oferuje elastyczną konfigurację dopasowaną do potrzeb Twojego projektu. Podstawowa konfiguracja znajduje się w pliku gollm.json.

Przykładowa konfiguracja

{
  "version": "0.2.0",
  "validation_rules": {
    "max_function_lines": 50,
    "max_file_lines": 300,
    "max_cyclomatic_complexity": 10,
    "max_function_params": 5,
    "max_line_length": 88,
    "forbid_print_statements": true,
    "forbid_global_variables": true,
    "require_docstrings": true,
    "require_type_hints": false,
    "naming_convention": "snake_case"
  },
  "project_management": {
    "todo_integration": true,
    "auto_create_tasks": true,
    "changelog_integration": true
  },
  "llm_integration": {
    "enabled": true,
    "provider": "openai",
    "model": "gpt-4"
  }
}

Integracja z narzędziami deweloperskimi

Integracja z Narzędziami

GoLLM można zintegrować z istniejącymi narzędziami deweloperskimi poprzez konfigurację w pliku gollm.json. Aby uzyskać więcej informacji, sprawdź dokumentację konfiguracji.

# Sprawdź aktualną konfigurację
gollm config list

# Zmień ustawienia konfiguracji
gollm config set <klucz> <wartość>

CI/CD

# Przykład dla GitHub Actions
name: goLLM Validation

on: [push, pull_request]

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'
    - name: Install goLLM
      run: pip install gollm[llm]
    - name: Run validation
      run: gollm validate .

📊 Metryki i analiza

goLLM dostarcza szczegółowych metryk i analiz, które pomagają śledzić jakość kodu w czasie.

Dostępne komendy

Metryki jakości kodu

# Pokaż aktualne metryki jakości kodu
gollm metrics

Trendy jakości w czasie

# Pokaż trendy jakości kodu w określonym okresie
gollm trend --period month

Status projektu

# Sprawdź aktualny status projektu i zdrowia kodu
gollm status

Przykładowe metryki

🤖 Integracja z modelami językowymi

goLLM może współpracować z różnymi dostawcami modeli językowych:

OpenAI GPT

export OPENAI_API_KEY="twój-klucz"
gollm config set llm.provider openai
gollm config set llm.model gpt-4

Anthropic Claude

export ANTHROPIC_API_KEY="twój-klucz"
gollm config set llm.provider anthropic
gollm config set llm.model claude-3-opus

Ollama (lokalny)

gollm config set llm.provider ollama
gollm config set llm.model codellama:13b

🌐 Wsparcie społeczności

Gdzie uzyskać pomoc?

Jak możesz pomóc?

  1. Zgłaszaj błędy i propozycje funkcji
  2. Udostępniaj przykłady użycia
  3. Pomagaj w tłumaczeniu dokumentacji
  4. Rozwijaj projekt przez pull requesty

📜 Licencja

Projekt goLLM jest dostępny na licencji Apache 2.0.

🤝 Integracja z LLM Providers

OpenAI

export OPENAI_API_KEY="sk-..."
gollm config set llm.provider openai
gollm config set llm.model gpt-4

Anthropic Claude

export ANTHROPIC_API_KEY="sk-ant-..."
gollm config set llm.provider anthropic
gollm config set llm.model claude-3-sonnet

📚 Dokumentacja

🤝 Wkład w Projekt

# Sklonuj repozytorium
git clone https://github.com/wronai/gollm
cd gollm

# Zainstaluj dla deweloperów
pip install -e .[dev]

# Uruchom testy
pytest

# Sprawdź jakość kodu
gollm validate-project

📄 Licencja

MIT License - zobacz LICENSE po szczegóły.

🌟 Roadmapa

goLLM - Gdzie jakość kodu spotyka się z inteligencją! 🚀45-90 minutes

🟡 MEDIUM Priority

Code Improvements

🎯 Podsumowanie Rozwiązania

goLLM (Go Learn, Lead, Master!) to kompletny system kontroli jakości kodu z integracją LLM, który automatycznie:

  1. Waliduje kod w czasie rzeczywistym - blokuje zapisywanie/wykonanie kodu niespełniającego standardów
  2. Integruje się z LLM - automatycznie poprawia kod przez AI z kontekstem projektu
  3. Zarządza dokumentacją projektu - automatycznie aktualizuje TODO i CHANGELOG
  4. Agreguje konfiguracje - łączy ustawienia z różnych narzędzi (flake8, black, mypy)

🚀 Kluczowe Komponenty

1. Core Engine (7 plików)

2. LLM Integration (8 plików)

3. Project Management (6 plików)

4. Real-time Monitoring (6 plików)

5. Configuration System (7 plików)

🎬 Przykład Kompletnego Workflow

Scenariusz: LLM generuje kod → goLLM kontroluje jakość

# 1. Użytkownik prosi LLM o kod
$ gollm generate "Create a user authentication system"

# 2. LLM generuje kod (przykład z naruszeniami)
# Generated code has: 9 parameters, print statements, high complexity

# 3. goLLM automatycznie waliduje
🔍 goLLM: Validating generated code...
❌ Found 4 violations:
   - Function has 9 parameters (max: 5)
   - Print statement detected
   - Cyclomatic complexity 12 (max: 10)
   - Missing docstring

# 4. goLLM wysyła feedback do LLM
🤖 Sending violations to LLM for improvement...

# 5. LLM generuje poprawiony kod
✅ Iteration 2: All violations resolved
📝 TODO updated: 0 new tasks (all fixed)
📝 CHANGELOG updated: Code generation entry added
💾 Code saved: user_auth.py
📊 Quality score: 85 → 92 (+7)

# 6. Automatyczne testy
🧪 Running validation on saved file...
✅ All checks passed
🚀 Ready for commit

Automatyczne Aktualizacje Dokumentacji

TODO.md (automatycznie zarządzane):

# TODO List - Updated: 2025-06-01 14:23:15

## 🔴 HIGH Priority (0 tasks)
✅ All high priority issues resolved!

## 🟡 MEDIUM Priority (2 tasks)
- [ ] Add unit tests for UserAuth class
- [ ] Add API documentation

## 🟢 LOW Priority (1 task)
- [ ] Optimize password hashing performance

CHANGELOG.md (automatycznie aktualizowane):

## [Unreleased] - 2025-06-01

### Added
- **[goLLM]** User authentication system with secure password handling
  - **File:** `user_auth.py`
  - **Quality Improvement:** +7 points
  - **LLM Generated:** ✅ Yes (2 iterations)

### Fixed  
- **[goLLM]** Resolved parameter count violation in authentication function
  - **Before:** 9 parameters
  - **After:** 2 parameters (using dataclass)
  - **Complexity Reduction:** 12 → 4

🛠️ Instalacja i Uruchomienie

Szybka Instalacja

# Sklonuj/pobierz goLLM
curl -sSL https://raw.githubusercontent.com/wronai/gollm/main/install.sh | bash

# Lub ręcznie
git clone https://github.com/wronai/gollm
cd gollm
./install.sh

Demo

# Uruchom demonstrację
./run_demo.sh

# Lub na Windows
run_demo.bat

Podstawowe Komendy

# Walidacja projektu
gollm validate-project

# Status jakości
gollm status

# Następne zadanie TODO
gollm next-task

# Generowanie kodu z LLM
gollm generate "create payment processor"
gollm generate "create website simple with frontend, api and backend"

# Auto-poprawki
gollm fix --auto

🔧 Konfiguracja

Plik gollm.json

{
  "validation_rules": {
    "max_function_lines": 50,
    "max_file_lines": 300,
    "forbid_print_statements": true,
    "require_docstrings": true
  },
  "llm_integration": {
    "enabled": true,
    "model_name": "gpt-4",
    "max_iterations": 3
  },
  "project_management": {
    "todo_integration": true,
    "changelog_integration": true
  }
}

Integracja z IDE i Narzędziami

GoLLM można zintegrować z IDE i narzędziami deweloperskimi poprzez konfigurację w pliku gollm.json.

# Sprawdź aktualną konfigurację
gollm config list

# Zmień ustawienia konfiguracji
gollm config set <klucz> <wartość>

Możliwe integracje:

📊 Metryki i Raportowanie

# Pokaż aktualne metryki jakości kodu
gollm metrics

# Pokaż trendy jakości kodu w określonym okresie
gollm trend --period month

# Sprawdź status projektu i zdrowia kodu
gollm status

# Przykładowy wynik:
Quality Score: 89/100
Code Coverage: 78%
Cyclomatic Complexity: 2.4 (Good)
Technical Debt: 3.2 days
Violations Fixed: 47
LLM Iterations: 156 (avg 2.3 per request)

🎯 Kluczowe Korzyści

  1. Zero-config Quality Control - działa out-of-the-box
  2. LLM-Powered Fixes - automatyczne poprawki przez AI
  3. Seamless Project Management - TODO/CHANGELOG bez wysiłku
  4. IDE Integration - wsparcie dla popularnych edytorów
  5. Git Workflow - automatyczne hooki i walidacja
  6. Extensible Architecture - łatwe dodawanie nowych reguł

🚀 Roadmapa

goLLM to kompletne rozwiązanie, które łączy kontrolę jakości kodu z mocą LLM, tworząc inteligentny system wspomagający deweloperów w pisaniu lepszego kodu! 🐍✨

🏗️ Architektura Systemu

Core Components (100% Complete)

  1. GollmCore - Główny orkiestrator
  2. CodeValidator - Walidacja AST + reguły jakości
  3. LLMOrchestrator - Integracja z AI (OpenAI/Anthropic/Ollama)
  4. TodoManager - Automatyczne TODO z naruszeń
  5. ChangelogManager - Automatyczne CHANGELOG
  6. ConfigAggregator - Łączenie konfiguracji z różnych narzędzi
  7. GitAnalyzer - Integracja z Git + hooks
  8. FileWatcher - Monitoring zmian w czasie rzeczywistym

Features (100% Implemented)

🤖 Ollama Integration - Gotowe do Użycia

Quick Setup

# 1. Zainstaluj Ollama
curl -fsSL https://ollama.ai/install.sh | sh

# 2. Pobierz model dla kodu
ollama pull codellama:7b        # 4GB RAM
ollama pull codellama:13b       # 8GB RAM - zalecane
ollama pull phind-codellama:34b # 20GB RAM - najlepsze

# 3. Uruchom Ollama
ollama serve

# 4. Zainstaluj goLLM
./install.sh

# 5. Skonfiguruj
gollm config set llm_integration.enabled true
gollm config set llm_integration.providers.ollama.enabled true
gollm config set llm_integration.providers.ollama.model codellama:7b

# 6. Test
gollm generate "Create a user authentication function"

Workflow z Ollama

# Użytkownik prosi o kod
gollm generate "Create payment processor with error handling"

# ↓ goLLM wysyła do Ollama z kontekstem:
# - Reguły jakości projektu (max 50 linii, no prints, etc.)
# - Ostatnie błędy i traceback
# - Zadania TODO do naprawy  
# - Standard kodowania zespołu
# - Historia zmian w plikach

# ↓ Ollama generuje kod Python

# ↓ goLLM automatycznie waliduje:
# ❌ Naruszenia znalezione → feedback do Ollama → iteracja
# ✅ Kod OK → zapis + aktualizacja TODO/CHANGELOG

# Rezultat: Wysokiej jakości kod zgodny ze standardami projektu

📊 Porównanie Providerów LLM

Provider Model Prywatność Koszt Jakość Szybkość Offline
Ollama CodeLlama 7B ✅ 100% ✅ Darmowy 🟡 Dobra 🟡 Średnia ✅ Tak
Ollama CodeLlama 13B ✅ 100% ✅ Darmowy ✅ Bardzo dobra 🟡 Średnia ✅ Tak
OpenAI GPT-4 ❌ 0% ❌ $0.03-0.12/1k ✅ Najlepsza ✅ Szybka ❌ Nie
Anthropic Claude-3 ❌ 0% ❌ $0.01-0.08/1k ✅ Bardzo dobra 🟡 Średnia ❌ Nie

Rekomendacja:

💡 Kluczowe Komendy

# Podstawowe
gollm validate-project     # Waliduj cały projekt
gollm status              # Pokaż status jakości
gollm next-task           # Pokaż następne zadanie TODO
gollm fix --auto          # Automatyczna naprawa problemów

# Integracja z LLM
gollm generate "zadanie"  # Generuj kod z pomocą AI
gollm fix --llm plik.py  # Napraw kod z pomocą AI

# Więcej informacji
gollm --help              # Wyświetl dostępne komendy
This site is open source. Improve this page.