django_agents

Contents:

  • Installation
    • Requirements
    • Install from PyPI
    • Install from Source
    • Configure Django Settings
    • Optional Configuration
    • Verify Installation
    • Next Steps
  • Quick Start Guide
    • 1. Create Your First Agent
    • 2. Implement Agent Logic
    • 3. Run Your Agent
    • 4. List All Agents
    • 5. Check Agent Health
    • 6. View Agent Statistics
    • Creating Different Agent Types
      • Base Agent (Synchronous)
      • Async Agent
      • Workflow Agent
      • API Agent
      • Data Processing Agent
    • Next Steps
  • API Reference
    • Base Agent Module
      • AgentException
      • AgentValidationError
      • AgentExecutionError
      • BaseAgent
        • BaseAgent.name
        • BaseAgent.description
        • BaseAgent.version
        • BaseAgent.enabled
        • BaseAgent.name
        • BaseAgent.description
        • BaseAgent.version
        • BaseAgent.enabled
        • BaseAgent.__init__()
        • BaseAgent.execute()
        • BaseAgent.validate_context()
        • BaseAgent.pre_execute()
        • BaseAgent.post_execute()
        • BaseAgent.run()
        • BaseAgent.log_info()
        • BaseAgent.log_warning()
        • BaseAgent.log_error()
        • BaseAgent.log_debug()
        • BaseAgent.get_stats()
        • BaseAgent.reset()
      • AsyncAgent
        • AsyncAgent.async_enabled
        • AsyncAgent.queue_name
        • AsyncAgent.priority
        • AsyncAgent.async_execute()
        • AsyncAgent.enqueue()
      • WorkflowAgent
        • WorkflowAgent.__init__()
        • WorkflowAgent.add_step()
        • WorkflowAgent.execute()
      • BaseAgent
        • BaseAgent
      • AsyncAgent
        • AsyncAgent
      • WorkflowAgent
        • WorkflowAgent
      • Exceptions
        • AgentException
        • AgentValidationError
        • AgentExecutionError
    • Agent Registry Module
      • AgentRegistry
        • AgentRegistry.__init__()
        • AgentRegistry.register()
        • AgentRegistry.unregister()
        • AgentRegistry.get_agent()
        • AgentRegistry.get_agent_class()
        • AgentRegistry.get_agent_metadata()
        • AgentRegistry.list_agents()
        • AgentRegistry.get_agents_by_app()
        • AgentRegistry.is_registered()
        • AgentRegistry.count()
        • AgentRegistry.clear()
        • AgentRegistry.autodiscover()
        • AgentRegistry.export_metadata()
        • AgentRegistry.__repr__()
      • autodiscover()
      • get_registry()
      • AgentRegistry
        • AgentRegistry
      • Global Functions
        • autodiscover()
        • get_registry()
    • Auditors Module
      • AuditReport
        • AuditReport.format
        • AuditReport.sections
        • AuditReport.total_issues
        • AuditReport.total_warnings
        • AuditReport.total_suggestions
        • AuditReport.__init__()
        • AuditReport.add_section()
        • AuditReport.generate()
        • AuditReport.get_summary()
      • BaseAuditor
        • BaseAuditor.critical
        • BaseAuditor.warnings
        • BaseAuditor.suggestions
        • BaseAuditor.good_practices
        • BaseAuditor.__init__()
        • BaseAuditor.audit()
        • BaseAuditor.get_result()
      • CodebaseAuditor
        • CodebaseAuditor.audit()
      • TestsAuditor
        • TestsAuditor.audit()
      • AppsAuditor
        • AppsAuditor.audit()
      • SettingsAuditor
        • SettingsAuditor.audit()
      • ProductionAuditor
        • ProductionAuditor.audit()
      • DatabaseAuditor
        • DatabaseAuditor.audit()
      • ServerAuditor
        • ServerAuditor.audit()
      • AuditReport
        • AuditReport
      • BaseAuditor
        • BaseAuditor
      • Specialized Auditors
        • CodebaseAuditor
        • TestsAuditor
        • AppsAuditor
        • SettingsAuditor
        • ProductionAuditor
        • DatabaseAuditor
        • ServerAuditor
      • Usage Example
    • Management Commands
      • list_agents
      • run_agent
      • create_agent
      • agent_stats
      • check_agents_health
      • generate_context
      • agent-audit
      • startproject
      • startapp
    • Core Modules
      • django_agents.base
        • AgentException
        • AgentValidationError
        • AgentExecutionError
        • BaseAgent
        • AsyncAgent
        • WorkflowAgent
      • django_agents.registry
        • AgentRegistry
        • autodiscover()
        • get_registry()
      • django_agents.auditors
        • AuditReport
        • BaseAuditor
        • CodebaseAuditor
        • TestsAuditor
        • AppsAuditor
        • SettingsAuditor
        • ProductionAuditor
        • DatabaseAuditor
        • ServerAuditor
      • django_agents.apps
        • DjangoAgentsConfig
      • django_agents.cli
  • Management Commands
    • Overview
    • Agent Discovery & Listing
      • list_agents
    • Agent Execution
      • run_agent
    • Agent Creation
      • create_agent
    • Monitoring & Health
      • agent_stats
      • check_agents_health
    • Code Quality & Auditing
      • agent-audit
    • AI Assistant Integration
      • generate_context
    • Project Scaffolding
      • startproject
      • startapp
    • Command Chaining
    • Integration with CI/CD
    • Shell Aliases
  • Examples
    • Email Notification Agent
    • Async Report Generation Agent
    • Order Processing Workflow
    • REST API Integration Agent
    • Data Processing Agent
    • Database Migration Agent
    • Scheduled Task Agent
    • Using Agents in Django Views
    • Using Agents in Celery Tasks
    • Testing Agents
  • Contributing
    • Development Setup
    • Code Style
    • Writing Tests
    • Documentation
    • Pull Request Process
    • Commit Message Guidelines
    • Adding New Features
    • Bug Reports
    • Feature Requests
    • Release Process
    • Code of Conduct
    • Getting Help
    • Thank You!
django_agents
  • API Reference
  • View page source

API Reference

This section contains the complete API reference for django-agents.

  • Base Agent Module
    • AgentException
    • AgentValidationError
    • AgentExecutionError
    • BaseAgent
    • AsyncAgent
    • WorkflowAgent
    • BaseAgent
    • AsyncAgent
    • WorkflowAgent
    • Exceptions
  • Agent Registry Module
    • AgentRegistry
    • autodiscover()
    • get_registry()
    • AgentRegistry
    • Global Functions
  • Auditors Module
    • AuditReport
    • BaseAuditor
    • CodebaseAuditor
    • TestsAuditor
    • AppsAuditor
    • SettingsAuditor
    • ProductionAuditor
    • DatabaseAuditor
    • ServerAuditor
    • AuditReport
    • BaseAuditor
    • Specialized Auditors
    • Usage Example
  • Management Commands
    • list_agents
    • run_agent
    • create_agent
    • agent_stats
    • check_agents_health
    • generate_context
    • agent-audit
    • startproject
    • startapp

Core Modules

django_agents.base

Base module for Django agents

django_agents.registry

Agent Registry for auto-discovery and centralized agent management.

django_agents.auditors

Django Agents Auditor Module.

django_agents.apps

Application configuration for django-agents.

django_agents.cli

Previous Next

© Copyright 2025, Dimitri Gaggioli.

Built with Sphinx using a theme provided by Read the Docs.