Skip to main content

CLI генератор документации для Django endpoints: Markdown + Structurizr PNG или Mermaid

Project description

dj-aidocgen

Генератор документации для Django endpoint'ов:

  • подробное описание алгоритма
  • последовательность действий (классы/методы)
  • C4 (Container)
  • диаграмма (Structurizr PNG или Mermaid)
  • Structurizr DSL

Установка (локально)

pip install -e .

Использование

export DJANGO_SETTINGS_MODULE=myproj.settings export OPENAI_API_KEY=sk-... # опционально dj-aidocgen --app users --handle user-detail --alg-name get_user_detail --diagram structurizr

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

dj_aidocgen-0.1.1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

dj_aidocgen-0.1.1-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file dj_aidocgen-0.1.1.tar.gz.

File metadata

  • Download URL: dj_aidocgen-0.1.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.6

File hashes

Hashes for dj_aidocgen-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b8b43ee9940fd210eeb8ab8091153f838339e1806482fa005931bc937c45680d
MD5 0bceda005ca3c75afa3ff1a0adc6ab25
BLAKE2b-256 86b870698eec8b4b24325be71d2ffa4543a5c1bd831fd70478812cec4d36374a

See more details on using hashes here.

File details

Details for the file dj_aidocgen-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: dj_aidocgen-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.6

File hashes

Hashes for dj_aidocgen-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a53a0e5ffa29f5589828ae3e9c5652ff3c2f8712c32ef47fd070c7a87b9b5427
MD5 ec7bedb9d93488ecfa32f60a8284c631
BLAKE2b-256 1e440a27596face0abea945532f07f628e5af58e86ddbae0b9ad0f3f00abb42c

See more details on using hashes here.

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