Skip to main content

AI-powered GitHub issue creation and management system for Django with conversational UX and LLM enhancement

Project description

Django Issue Capture

AI-powered GitHub issue creation and management system for Django with conversational UX and LLM enhancement.

Features

  • AI-Powered Issue Generation: Use LiteLLM to generate comprehensive issues from basic descriptions
  • Model Optionality: Support for OpenAI, Anthropic, Ollama, and any LiteLLM-compatible provider
  • Conversational UI: Chat-based interface for gathering issue context
  • GitHub Integration: Direct promotion of issues to GitHub repositories
  • Template System: Predefined templates for bugs, features, tasks, and enhancements
  • HTMX Admin: Interactive admin interface with one-click GitHub promotion
  • Markdown Support: Full markdown rendering with sanitization

Installation

pip install django-issue-capture

Quick Start

  1. Add to INSTALLED_APPS:
INSTALLED_APPS = [
    # ...
    "solo",  # Required dependency
    "django_markdownify",  # For markdown rendering
    "django_issue_capture",
]
  1. Add context processor (optional, for floating button):
TEMPLATES = [{
    'OPTIONS': {
        'context_processors': [
            # ...
            'django_issue_capture.context_processors.issue_capture_settings',
        ],
    },
}]
  1. Include URLs:
from django.urls import include, path

urlpatterns = [
    # ...
    path("issues/", include("django_issue_capture.urls")),
]
  1. Run migrations:
python manage.py migrate
  1. Configure in Django Admin:

Navigate to Issue Capture Settings and configure:

  • GitHub: Repository (owner/repo) and Personal Access Token
  • LLM: API key and model (e.g., gpt-4o-mini, claude-3-5-sonnet-20241022)
  1. Set up issue templates:
python manage.py setup_issue_templates

Configuration

LLM Models

Supports any LiteLLM-compatible model:

  • OpenAI: gpt-4o-mini, gpt-4o, gpt-3.5-turbo
  • Anthropic: claude-3-5-sonnet-20241022, claude-3-opus-20240229
  • Local: ollama/llama3, ollama/mistral
  • Others: See LiteLLM docs

GitHub Integration

Requires a Personal Access Token with repo scope:

  1. Go to GitHub Settings → Developer settings → Personal access tokens
  2. Generate new token with repo scope
  3. Add to Issue Capture Settings in Django admin

Environment Variables (Production)

For production, use environment variables:

# settings.py
from django.conf import settings

# Override singleton defaults with env vars
ISSUE_CAPTURE_LLM_API_KEY = os.getenv("ISSUE_CAPTURE_LLM_API_KEY")
ISSUE_CAPTURE_GITHUB_API_KEY = os.getenv("GITHUB_API_KEY")

Usage

Create Issue via UI

  1. Navigate to /issues/create/
  2. Choose creation mode:
    • Standard Form: Manual entry
    • AI Quick Generate: One-shot AI enhancement
    • AI Chat: Conversational context gathering

Promote to GitHub

  1. View issues at /issues/list/
  2. Click issue to view details
  3. Click "Promote to GitHub" (or use admin interface)

Admin Interface

The Django admin provides:

  • Issue management with status tracking
  • One-click GitHub promotion (HTMX-powered)
  • Template configuration
  • Conversation history viewing

Development

# Clone and install
git clone https://github.com/directory-platform/django-issue-capture
cd django-issue-capture
uv sync --extra dev

# Run tests
PYTHONPATH=. uv run python tests/manage.py test

# Run quality checks
ruff check src/ tests/
ruff format src/ tests/
mypy src/

Dependencies

  • Django ≥ 4.2
  • django-solo ≥ 2.0
  • shortuuid ≥ 1.0
  • requests ≥ 2.32
  • litellm ≥ 1.70
  • django-markdownify ≥ 0.9

License

MIT License - see LICENSE file for details.

Contributing

Contributions welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new functionality
  4. Ensure all tests pass
  5. Submit a pull request

Support

Credits

Part of the Directory Platform ecosystem. Extracted from directory-builder.

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

django_issue_capture-0.1.0.tar.gz (41.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_issue_capture-0.1.0-py3-none-any.whl (48.0 kB view details)

Uploaded Python 3

File details

Details for the file django_issue_capture-0.1.0.tar.gz.

File metadata

  • Download URL: django_issue_capture-0.1.0.tar.gz
  • Upload date:
  • Size: 41.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for django_issue_capture-0.1.0.tar.gz
Algorithm Hash digest
SHA256 efd25e513bac5ba37377ad659fafab0bb43611e3debecff3378ff50f4a9a6ae0
MD5 89ba2a82df08268829cc9be8616f01da
BLAKE2b-256 af7bf3deec1673320f809f07d739b760fe205f8a1a336cb1535e8bdd3b341c91

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_issue_capture-0.1.0.tar.gz:

Publisher: publish.yml on heysamtexas/django-issue-capture

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_issue_capture-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_issue_capture-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de9aba3980d3acf1c4105260fdcd5e07a554bcce9acdb24abc43f848bb75f48a
MD5 01f445b6d3015ead2f01eebe8a605e19
BLAKE2b-256 fd1e4bb1fee7123c6feddeccd732d307021b29a5a9639bac89bdb996404bbcae

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_issue_capture-0.1.0-py3-none-any.whl:

Publisher: publish.yml on heysamtexas/django-issue-capture

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page