tekrepodoc

Tekrepodoc

Утилита инструмента для создания общих файлов проекта с использованием разумных шаблонов, с которыми каждый может договориться. Полезно для репозитории GIT, поддерживает шаблоны Sphinx, файлы здоровья сообщества, чтения, конфигурации проекта PYPI.

---

Оглавление

• QuickStart
• Документация/Использование
• Внося
• Кредиты

---

QuickStart

Установка

 pip install tekrepodoc 

Из источника

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

python setup.py bdist_wheel
pip install -e .

---

Использование CLI

В типе терминала

 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>

Сначала генерируйте файл конфигурации

 repodoc config --init

Документация

Ссылка на API

---

Внося

---

Юридическое уведомление

Если этот репозиторий использует сторонние API и или ИИ-модели, он не связан с поставщиками API или одобрена или одобрена или оригинальными разработчиками моделей.

Обратите внимание на следующее:

Отказ от ответственности : API, услуги и товарные знаки, упомянутые в этом хранилище, принадлежат их соответствующим владельцам. Этот проект не претендует на них.

Ответственность : автор этого хранилища не несет ответственности за какие-либо последствия, возникающие в результате использования или неправильного использования этого хранилища, или содержания, предоставляемого сторонним API и любыми ущербами или убытками, вызванными действиями пользователей.

Образовательные цели : этот репозиторий и его содержание предоставляются строго для образовательных целей. Используя предоставленную информацию и код, пользователи признают, что они используют API и модели на свой собственный риск и соглашаются соблюдать любые применимые законы и правила.

Кредиты