django-admin-docs-llm
A Django pluggable app for Administrative LLM Documentation.
Installation
# 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:
INSTALLED_APPS = [
...
'admindocs_llm',
...
]
Include the app URLs in your project's urls.py:
from django.urls import path, include
urlpatterns = [
...
path('admindocs/', include('admindocs_llm.urls')),
...
]
Development
Setup
# Clone the repository
git clone <repository-url>
cd django-admin-docs-llm
# Install dependencies with test extras
uv sync --extra test
Running Tests
# 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
# 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 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.
# 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
1 maintainer
Metadata
1 maintainer
Release files for django-admin-docs-llm 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| django_admin_docs_llm-0.2.0.tar.gz | 49.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_admin_docs_llm-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 62.7 kB
Release files / django_admin_docs_llm-0.2.0.tar.gz
| Download URL | django_admin_docs_llm-0.2.0.tar.gz |
|---|---|
| Size | 49.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7524f33cde6269bfc8aa6f5c5ba6c43317c3da10e70ce1a519cd06e5da2cfe08
|
|
BLAKE2b-256 checksum How to use checksums |
3a0584a87fea62cdb4468811a46a911e31a394d4d25d5369096da0c2e7b6d616
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.14
|
Release files / django_admin_docs_llm-0.2.0-py3-none-any.whl
| Download URL | django_admin_docs_llm-0.2.0-py3-none-any.whl |
|---|---|
| Size | 13.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6f6e0cd0e4809891f53ad207ac066db6a1a1e359d2c380c60537fb8e684f96c8
|
|
BLAKE2b-256 checksum How to use checksums |
398c36b86f9e98788452607a0f76214e3a06a7292c54c03173bf97a8aed7d29f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.14
|
Security for django-admin-docs-llm 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
