Overview

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

Available AI and models:

• OpenAI (https://platform.openai.com/)

• GitHub Copilot (https://github.com/)

• Gemini (https://aistudio.google.com/)

(Note: You will need to set up your own API keys for the above AI providers, which may require paid subscriptions.)

Usage

Installation:

pip3 install ai_documentation_orchestrator
# or
python3 -m pip install ai_documentation_orchestrator

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 "/home/user/code/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"