tekrepodoc

Tekrepodoc

Ferramenta de utilitário para gerar arquivos de projeto comuns usando modelos sensíveis em que todos podem concordar. Útil para repositórios Git, suporta modelos de Esfinge, arquivos de saúde comunitária, leitura, configurações de projeto PYPI.

---

Índice

• Investir rápido
• Documentação/uso
• Contribuindo
• Créditos

---

Investir rápido

Instalação

 pip install tekrepodoc 

Da fonte

 git clone https://github.com/TralahM/tekrepodoc
cd tekrepodoc

python setup.py bdist_wheel
pip install -e .

---

Uso da CLI

No tipo de terminal

 repodoc -h 

 usage: repodoc [-h] [-u] [-bc] [-zc] [-vv] [-v]
               {get_vars,config,licence,readme,community_health,comh,ch,pypi_project,pypi,sphinx_docs,docs,sphinx,dot_files,dots}
               ...

options:
  -h, --help            show this help message and exit
  -u, --use-config-file
                        use config file for template variables.
  -bc, --bash-completion
                        Print Bash Completion Script.
  -zc, --zsh-completion
                        Print ZSH Completion Script.
  -vv, --verbose        Turn on Verbose Mode.
  -v, --version         show program's version number and exit

subcommands:
  {get_vars,config,licence,readme,community_health,comh,ch,pypi_project,pypi,sphinx_docs,docs,sphinx,dot_files,dots}
    get_vars            Return all variables for the given template.
    config              Configure Subcommand to init,set,get,list configs.
    licence             Generate Licence Command.
    readme              Generate README command.
    community_health (comh, ch)
                        Generate Community Health Guidelines.
    pypi_project (pypi)
                        Generate Pypi Manifest,setup.cfg,setup.py Command.
    sphinx_docs (docs, sphinx)
                        Generate Sphinx Documentation Templates.
    dot_files (dots)    Generate all dot files
                        .gitignore,.gitattributes,.mailmap.

Author: Tralah M Brian (TralahM) <[email protected]>. Project:
<https://github.com/TralahM/tekrepodoc>

Primeiro gerar um arquivo de configuração

 repodoc config --init

Documentação

Referência da API

---

Contribuindo

---

Aviso legal

Se este repositório usar APIs de terceiros e / ou modelos de IA, ele não está associado ou endossado pelos provedores da API ou pelos desenvolvedores originais dos modelos.

Observe o seguinte:

Isenção de responsabilidade : as APIs, serviços e marcas registradas mencionadas neste repositório pertencem a seus respectivos proprietários. Este projeto não está reivindicando nenhum direito sobre eles.

Responsabilidade : O autor deste repositório não é responsável por quaisquer consequências decorrentes do uso ou uso indevido deste repositório ou do conteúdo fornecido pelas APIs de terceiros e por quaisquer danos ou perdas causados ​​pelas ações dos usuários.

Somente fins educacionais : este repositório e seu conteúdo são fornecidos estritamente para fins educacionais. Ao usar as informações e o código fornecidos, os usuários reconhecem que estão usando as APIs e modelos por sua conta e risco e concordam em cumprir quaisquer leis e regulamentos aplicáveis.

Créditos