Metadata-Version: 2.4
Name: django-admin-docs-llm
Version: 0.2.0
Summary: A markdown converter for Django's admin docs to make it LLM friendly.
Project-URL: Homepage, https://github.com/fitoria/django-admindocs-llm
Project-URL: Repository, https://github.com/fitoria/django-admindocs-llm
Project-URL: Issues, https://github.com/fitoria/django-admindocs-llm/issues
Author-email: Adolfo Fitoria <adolfo@fitoria.net>
License: MIT License
        
        Copyright (c) 2026 Adolfo Fitoria
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
License-File: LICENSE.md
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Framework :: Django :: 5.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Requires-Dist: django>=4.2
Requires-Dist: docutils>=0.22.4
Requires-Dist: markitdown>=0.1.4
Provides-Extra: dev
Requires-Dist: ruff>=0.8.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-django>=4.5.0; extra == 'test'
Requires-Dist: pytest>=7.0.0; extra == 'test'
Description-Content-Type: text/markdown

# django-admin-docs-llm

A Django pluggable app for Administrative LLM Documentation.

## Installation

```bash
# Using uv
uv add django-admin-docs-llm

# Or using pip
pip install django-admin-docs-llm
```

## Configuration

Add `admindocs_llm` to your `INSTALLED_APPS` in Django settings:

```python
INSTALLED_APPS = [
    ...
    'admindocs_llm',
    ...
]
```

Include the app URLs in your project's `urls.py`:

```python
from django.urls import path, include

urlpatterns = [
    ...
    path('admindocs/', include('admindocs_llm.urls')),
    ...
]
```

## Development

### Setup

```bash
# Clone the repository
git clone <repository-url>
cd django-admin-docs-llm

# Install dependencies with test extras
uv sync --extra test
```

### Running Tests

```bash
# Run all tests
./runtests.sh

# Run with coverage
./runtests.sh --cov=admindocs_llm

# Run specific test file
./runtests.sh tests/test_app.py
```

### Test Django Server

```bash
# Run migrations
./manage.sh migrate

# Create superuser
./manage.sh createsuperuser

# Run development server
./manage.sh runserver
```

Then visit `http://localhost:8000/admin/` and `http://localhost:8000/admindocs/`

See [tests/README.md](tests/README.md) for more details about the test project.

## Settings

### `ADMINDOCS_LLM_EXCLUDE_APPS`

By default, all `django.contrib.*` apps are excluded from the LLM documentation output (models, views, tags, filters) since LLMs already know Django's built-in components.

```python
# Override to exclude only specific apps
ADMINDOCS_LLM_EXCLUDE_APPS = ['admin', 'auth', 'contenttypes']

# Disable filtering entirely (show everything)
ADMINDOCS_LLM_EXCLUDE_APPS = []
```

## Requirements

- Python >= 3.10
- Django >= 4.2
- markitdown >= 0.1.4

## License

MIT