Gerador de documentacao tecnica e manual de servico em DOCX para robos de automacao.
Project description
DocAut_Padronizado
HomePage: https://pypi.org/manage/project/DocAut_Padronizado/releases/
Repositorio: https://github.com/kpersich0054/Biblioteca_Documenta-o_AE
Biblioteca PyPI para gerar automaticamente:
{robo}_documentacao_tecnica.docx{robo}_manual_servico.docx
com base no padrao definido em padrao_documentacao.md.
Recursos
- Gera Documentacao Tecnica com secoes obrigatorias.
- Gera Manual de Servico com linguagem orientada ao negocio.
- Aplica estilo visual padrao (titulos azuis, tabelas com cabecalho azul e linhas alternadas).
- Suporta primeira versao e atualizacao.
- Em atualizacao, extrai historico de alteracoes dos DOCX existentes e adiciona nova entrada.
Instalacao local
pip install -e .
CLI
Depois da instalacao, o comando disponivel e:
rpa-docs
1. Primeira versao com JSON
rpa-docs generate --input example_project_data.json --output-dir ./saida
2. Atualizacao de versao
rpa-docs update \
--input example_project_data.json \
--output-dir ./saida \
--existing-tech "C:/docs/meu_robo_documentacao_tecnica.docx" \
--existing-service "C:/docs/meu_robo_manual_servico.docx" \
--updated-by "Maria Souza" \
--change-description "Ajuste de regras de validacao"
3. Modo interativo
rpa-docs wizard --output-dir ./saida
Estrutura esperada de JSON
Use o arquivo example_project_data.json como base.
Campos principais:
robot_namedeveloper_namemachine_namecode_pathtechnical_objectiveservice_deliverybusiness_problem- tabelas em formato lista de objetos (ex:
credentials_rows,indicators_rows)
Publicacao no PyPI
- Atualize a versao no
pyproject.toml. - Gere os pacotes:
python -m pip install --upgrade build twine
python -m build
- Publique no TestPyPI (recomendado primeiro):
python -m twine upload --repository testpypi dist/*
- Publique no PyPI oficial:
python -m twine upload dist/*
Observacoes
- O manual nao inclui secao de "Proximos Passos".
- O e-mail de suporte da automacao e sempre incluido:
rpa.tiop@broadcast.com.br. - O ponto focal de negocio e preenchido pelo campo
focal_point.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file docaut_padronizado-0.1.1.tar.gz.
File metadata
- Download URL: docaut_padronizado-0.1.1.tar.gz
- Upload date:
- Size: 3.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
128be19b0972305f093a945d663f23a3b833daa0ca257ecbb5b16c93e192b61a
|
|
| MD5 |
91c72af63743aae874a992a6a7deafc9
|
|
| BLAKE2b-256 |
bc6d4c3c63b1f94c9c9c3090cecf1aafb5e7ebf6c3fc660dc0e0712dd5170ff4
|
File details
Details for the file docaut_padronizado-0.1.1-py3-none-any.whl.
File metadata
- Download URL: docaut_padronizado-0.1.1-py3-none-any.whl
- Upload date:
- Size: 9.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fcef56ca3ccca22eee42cdc546ff05a077e827e47fec5fde4cf02a6db54616cd
|
|
| MD5 |
0e0102f04c3b980110c024ce5423ebb4
|
|
| BLAKE2b-256 |
115f0d28005eece1125582fe87b31548ab7c33010789eea1236d749cce28e8a1
|