Skip to main content

Orchestrate the creation of a documentation file plus a technical diagram.

Project description

Overview

Orchestrate the creation of a documentation file plus a technical diagram.

Usage

Installation:

pip3 install ai_documentation_orchestrator
# or
python3 -m pip install ai_documentation_orchestrator

CLI:

ai_doc_orchestrator \
   -t "AWS Account Management with Terraform" \
   -c "./aws_accounts.tf" \
   -m "gpt-5" \
   -i "gemini-3.1-flash-lite-image" \
   -b "./documentation.md" \
   -r "./refs/documentation_format.md" \
   -p "./prompts/diagram.txt" \
   -d "./diagram.png" \
   -n
   -k "my-gemini-api-key" \
   -g "./prompts/gen_doc.txt" \
   -u "./prompts/update_doc.txt" \

Available options:

ai_doc_orchestrator -h

Examples (with defaults):

ai_doc_orchestrator \
   -t "authenticating to AWS with Python" \
   -c "the Python module at https://gitlab.com/fer1035_python/modules/pypi-aws_authenticator"
ai_doc_orchestrator \
   -t "GCP tagging policy management" \
   -c "https://gitlab.com/fer1035_terraform/modules/terraform-google-tagging-policy"
ai_doc_orchestrator \
   -t "Automating Documentation" \
   -c "the Python code at https://gitlab.com/fer1035_python/modules/pypi-ai_documentation_orchestrator"

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

ai_documentation_orchestrator-1.0.3.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

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

ai_documentation_orchestrator-1.0.3-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file ai_documentation_orchestrator-1.0.3.tar.gz.

File metadata

File hashes

Hashes for ai_documentation_orchestrator-1.0.3.tar.gz
Algorithm Hash digest
SHA256 3de02772e26ab33017b3622ae20ecf4c133cf9a69d4856804bd29c2149d5795e
MD5 2847c8c9a4643c65bd25aafb72d09bb0
BLAKE2b-256 852bdf196bfb4ae894a4bfd580b2582eb834d444d5011f1cb50a9fb50db85783

See more details on using hashes here.

File details

Details for the file ai_documentation_orchestrator-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_documentation_orchestrator-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a6d6246cbf27ffd49475a6667633e1a02e30e6801c4f917a96c8341ea9ffe07d
MD5 3ef509773ca84d92138756b1b24d18dd
BLAKE2b-256 4ddb7c9967223bbe34e7491f860590744fcf1a9011bf7261a5b9f7b51cb5685e

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