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.0.tar.gz (7.1 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.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dj_aidocgen-0.1.0.tar.gz
  • Upload date:
  • Size: 7.1 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.0.tar.gz
Algorithm Hash digest
SHA256 d3ba0f158f93169f6a85a45bf8a9c565df4650856b0666f0445740623ab82cd4
MD5 76bda5a36db6d0e4386b6e2b714a80b1
BLAKE2b-256 1f1c13d3380b615ed164e372e0084ddd82af854621e14a5d9be184bd8cfcf7fd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dj_aidocgen-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 760d5106947714c7834cd10391f50b618342249576a1205ac6767e6466a5b57b
MD5 12eed4e45c88d95e3f8e730fb9eae72c
BLAKE2b-256 f6e52052205172d9aaa0c0d6fe069c462cddf918ad37dc6375cdcca99dd6d99d

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