Installation
============

Requirements
------------

* Python 3.8 or higher
* Django 3.2 or higher

Install from PyPI
-----------------

.. code-block:: bash

    pip install django_agents

Install from Source
-------------------

.. code-block:: bash

    git clone https://github.com/dim-gggl/django_agents.git
    cd django_agents
    pip install -e .

Configure Django Settings
--------------------------

Add ``django_agents`` to your ``INSTALLED_APPS``:

.. code-block:: python

    # settings.py
    INSTALLED_APPS = [
        # Django apps
        'django.contrib.admin',
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',

        # Third-party apps
        'django_agents',

        # Your apps
        'myapp',
    ]

Optional Configuration
----------------------

You can customize django-agents behavior in your settings:

.. code-block:: python

    # settings.py
    DJANGO_AGENTS = {
        'AUTO_DISCOVER': True,  # Automatically discover agents on startup
        'SKIP_AUTODISCOVER': [
            'django.contrib.admin',
            'django.contrib.auth',
            # Add apps to skip during autodiscovery
        ],
    }

Verify Installation
-------------------

Run the following command to verify the installation:

.. code-block:: bash

    python manage.py list_agents

You should see output indicating that django-agents is installed and working.

Next Steps
----------

* Read the :doc:`quickstart` guide
* Create your first agent: ``python manage.py create_agent MyAgent myapp``
* Explore the :doc:`api/index`