tekrepodoc

tekrepodoc

Herramienta de utilidad para generar archivos de proyecto comunes utilizando plantillas sensibles en las que todos pueden acordar. Útil para repositorios Git, admite plantillas Sphinx, archivos de salud comunitarios, lecturas, configuraciones de proyectos PYPI.

---

Tabla de contenido

• Inicio rápido
• Documentación/uso
• Que contribuye
• Créditos

---

Inicio rápido

Instalación

 pip install tekrepodoc 

De la fuente

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

python setup.py bdist_wheel
pip install -e .

---

Uso de CLI

En tipo 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>

Primero genere un archivo de configuración

 repodoc config --init

Documentación

Referencia de API

---

Que contribuye

---

Aviso legal

Si este repositorio utiliza API de terceros y modelos AI, no está asociado o respaldado por los proveedores de API o los desarrolladores originales de los modelos.

Tenga en cuenta lo siguiente:

Descargo de responsabilidad : las API, los servicios y las marcas comerciales mencionadas en este repositorio pertenecen a sus respectivos dueños. Este proyecto no reclama ningún derecho sobre ellos.

Responsabilidad : El autor de este repositorio no es responsable de las consecuencias derivadas del uso o mal uso de este repositorio o del contenido proporcionado por las API de terceros y cualquier daño o pérdida causado por las acciones de los usuarios.

Solo propósitos educativos : este repositorio y su contenido se proporcionan estrictamente para fines educativos. Al utilizar la información y el código proporcionado, los usuarios reconocen que están utilizando las API y los modelos en su propio riesgo y aceptan cumplir con las leyes y regulaciones aplicables.

Créditos