| Name | tekrepodoc JSON |
| Version |
0.0.9
JSON |
| download |
| home_page | https://github.com/TralahM/tekrepodoc |
| Summary | Utility Tool to Generate Common Project Files using sensible templates every one can agree on. Useful for Git Repositories, Supports Sphinx templates, Community Health Files, READMEs, pypi project configurations. |
| upload_time | 2023-08-12 13:14:57 |
| maintainer | |
| docs_url | None |
| author | Tralah M Brian |
| requires_python | |
| license | GPLV3 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src="https://img.shields.io/github/license/TralahM/tekrepodoc"> <img src="https://img.shields.io/github/last-commit/TralahM/tekrepodoc"> <img src="https://img.shields.io/github/contributors/TralahM/tekrepodoc"> <img src="https://img.shields.io/github/issues-pr-raw/TralahM/tekrepodoc?color=blue"> <img src="https://img.shields.io/github/issues-pr-closed-raw/TralahM/tekrepodoc?color=red"> <img src="https://img.shields.io/github/issues-raw/TralahM/tekrepodoc?color=green"> <img src="https://img.shields.io/github/issues-closed-raw/TralahM/tekrepodoc?color=yellow"> <img src="https://img.shields.io/github/forks/TralahM/tekrepodoc?label=Forks&style=social"> <img src="https://img.shields.io/github/forks/TralahM/tekrepodoc?label=Forks&style=social"> <img src="https://img.shields.io/github/stars/TralahM/tekrepodoc?style=social"> <img src="https://img.shields.io/github/watchers/TralahM/tekrepodoc?label=Watch&style=social"> <img src="https://img.shields.io/github/downloads/TralahM/tekrepodoc/total"> <img src="https://img.shields.io/github/repo-size/TralahM/tekrepodoc"> <img src="https://img.shields.io/github/languages/count/TralahM/tekrepodoc"> <img src="https://img.shields.io/github/v/tag/TralahM/tekrepodoc"> <img src="https://img.shields.io/readthedocs/tekrepodoc">
<img src="https://img.shields.io/pypi/v/tekrepodoc"> <img src="https://img.shields.io/pypi/pyversions/tekrepodoc"> <img src="https://img.shields.io/pypi/wheel/tekrepodoc"> <img src="https://img.shields.io/pypi/status/tekrepodoc?label=pypi%20status"> <img src="https://img.shields.io/pypi/format/tekrepodoc?label=pypi%20format">
# tekrepodoc
> Utility Tool to Generate Common Project Files using sensible templates every one can agree on. Useful for Git Repositories, Supports Sphinx templates, Community Health Files, READMEs, pypi project configurations.
---
### Table of Contents
- [QuickStart](#QuickStart)
- [Documentation/Usage](#Documentation)
- [Contributing](#Contributing)
- [Credits](#Credits)
---
## QuickStart
#### Installation
```console
pip install tekrepodoc
```
#### From Source
```console
git clone https://github.com/TralahM/tekrepodoc
cd tekrepodoc
python setup.py bdist_wheel
pip install -e .
```
---
## CLI Usage
In terminal type
```console
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) <musyoki.brian@tralahtek.com>. Project:
<https://github.com/TralahM/tekrepodoc>
```
### First Generate a Configuration File
```console
repodoc config --init
```
## Documentation
[](https://tekrepodoc.readthedocs.io)
#### API Reference
---
## Contributing
---
## Legal Notice
If this repository uses third-party APIs and or AI models, it is not associated with or endorsed by the API providers or the original developers of the models.
Please note the following:
**Disclaimer**: The APIs, services, and trademarks mentioned in this repository belong to their respective owners. This project is not claiming any right over them.
**Responsibility**: The author of this repository is not responsible for any consequences arising from the use or misuse of this repository or the content provided by the third-party APIs and any damage or losses caused by users' actions.
**Educational Purposes Only**: This repository and its content are provided strictly for educational purposes. By using the information and code provided, users acknowledge that they are using the APIs and models at their own risk and agree to comply with any applicable laws and regulations.
## Credits
[](https://github.com/TralahTek)
[](https://github.com/TralahM)
[](https://github.com/TralahM)
[](https://github.com/TralahM)
[](https://twitter.com/TralahM)
[](https://kaggle.com/TralahM)
[](https://linkedin.com/in/TralahM)
[](https://tralahm.tralahtek.com)
[](https://org.tralahtek.com)
---
Raw data
{
"_id": null,
"home_page": "https://github.com/TralahM/tekrepodoc",
"name": "tekrepodoc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tralah M Brian",
"author_email": "musyoki.brian@tralahtek.com",
"download_url": "",
"platform": null,
"description": "<img src=\"https://img.shields.io/github/license/TralahM/tekrepodoc\"> <img src=\"https://img.shields.io/github/last-commit/TralahM/tekrepodoc\"> <img src=\"https://img.shields.io/github/contributors/TralahM/tekrepodoc\"> <img src=\"https://img.shields.io/github/issues-pr-raw/TralahM/tekrepodoc?color=blue\"> <img src=\"https://img.shields.io/github/issues-pr-closed-raw/TralahM/tekrepodoc?color=red\"> <img src=\"https://img.shields.io/github/issues-raw/TralahM/tekrepodoc?color=green\"> <img src=\"https://img.shields.io/github/issues-closed-raw/TralahM/tekrepodoc?color=yellow\"> <img src=\"https://img.shields.io/github/forks/TralahM/tekrepodoc?label=Forks&style=social\"> <img src=\"https://img.shields.io/github/forks/TralahM/tekrepodoc?label=Forks&style=social\"> <img src=\"https://img.shields.io/github/stars/TralahM/tekrepodoc?style=social\"> <img src=\"https://img.shields.io/github/watchers/TralahM/tekrepodoc?label=Watch&style=social\"> <img src=\"https://img.shields.io/github/downloads/TralahM/tekrepodoc/total\"> <img src=\"https://img.shields.io/github/repo-size/TralahM/tekrepodoc\"> <img src=\"https://img.shields.io/github/languages/count/TralahM/tekrepodoc\"> <img src=\"https://img.shields.io/github/v/tag/TralahM/tekrepodoc\"> <img src=\"https://img.shields.io/readthedocs/tekrepodoc\">\n<img src=\"https://img.shields.io/pypi/v/tekrepodoc\"> <img src=\"https://img.shields.io/pypi/pyversions/tekrepodoc\"> <img src=\"https://img.shields.io/pypi/wheel/tekrepodoc\"> <img src=\"https://img.shields.io/pypi/status/tekrepodoc?label=pypi%20status\"> <img src=\"https://img.shields.io/pypi/format/tekrepodoc?label=pypi%20format\">\n\n# tekrepodoc\n> Utility Tool to Generate Common Project Files using sensible templates every one can agree on. Useful for Git Repositories, Supports Sphinx templates, Community Health Files, READMEs, pypi project configurations.\n\n\n---\n\n### Table of Contents\n- [QuickStart](#QuickStart)\n- [Documentation/Usage](#Documentation)\n- [Contributing](#Contributing)\n- [Credits](#Credits)\n\n---\n## QuickStart\n#### Installation\n\n```console\npip install tekrepodoc\n```\n#### From Source\n```console\ngit clone https://github.com/TralahM/tekrepodoc\ncd tekrepodoc\n\npython setup.py bdist_wheel\npip install -e .\n\n```\n---\n\n## CLI Usage\nIn terminal type\n```console\nrepodoc -h\n```\n\n```\nusage: repodoc [-h] [-u] [-bc] [-zc] [-vv] [-v]\n {get_vars,config,licence,readme,community_health,comh,ch,pypi_project,pypi,sphinx_docs,docs,sphinx,dot_files,dots}\n ...\n\noptions:\n -h, --help show this help message and exit\n -u, --use-config-file\n use config file for template variables.\n -bc, --bash-completion\n Print Bash Completion Script.\n -zc, --zsh-completion\n Print ZSH Completion Script.\n -vv, --verbose Turn on Verbose Mode.\n -v, --version show program's version number and exit\n\nsubcommands:\n {get_vars,config,licence,readme,community_health,comh,ch,pypi_project,pypi,sphinx_docs,docs,sphinx,dot_files,dots}\n get_vars Return all variables for the given template.\n config Configure Subcommand to init,set,get,list configs.\n licence Generate Licence Command.\n readme Generate README command.\n community_health (comh, ch)\n Generate Community Health Guidelines.\n pypi_project (pypi)\n Generate Pypi Manifest,setup.cfg,setup.py Command.\n sphinx_docs (docs, sphinx)\n Generate Sphinx Documentation Templates.\n dot_files (dots) Generate all dot files\n .gitignore,.gitattributes,.mailmap.\n\nAuthor: Tralah M Brian (TralahM) <musyoki.brian@tralahtek.com>. Project:\n<https://github.com/TralahM/tekrepodoc>\n```\n\n### First Generate a Configuration File\n\n```console\nrepodoc config --init\n\n```\n\n## Documentation\n\n[](https://tekrepodoc.readthedocs.io)\n\n\n#### API Reference\n\n---\n## Contributing\n\n---\n\n\n## Legal Notice\nIf this repository uses third-party APIs and or AI models, it is not associated with or endorsed by the API providers or the original developers of the models.\n\nPlease note the following:\n\n**Disclaimer**: The APIs, services, and trademarks mentioned in this repository belong to their respective owners. This project is not claiming any right over them.\n\n**Responsibility**: The author of this repository is not responsible for any consequences arising from the use or misuse of this repository or the content provided by the third-party APIs and any damage or losses caused by users' actions.\n\n**Educational Purposes Only**: This repository and its content are provided strictly for educational purposes. By using the information and code provided, users acknowledge that they are using the APIs and models at their own risk and agree to comply with any applicable laws and regulations.\n\n\n## Credits\n[](https://github.com/TralahTek)\n[](https://github.com/TralahM)\n[](https://github.com/TralahM)\n\n\n\n[](https://github.com/TralahM)\n[](https://twitter.com/TralahM)\n[](https://kaggle.com/TralahM)\n[](https://linkedin.com/in/TralahM)\n\n\n[](https://tralahm.tralahtek.com)\n\n[](https://org.tralahtek.com)\n---\n",
"bugtrack_url": null,
"license": "GPLV3",
"summary": "Utility Tool to Generate Common Project Files using sensible templates every one can agree on. Useful for Git Repositories, Supports Sphinx templates, Community Health Files, READMEs, pypi project configurations.",
"version": "0.0.9",
"project_urls": {
"Documentation": "https://github.com/TralahM/tekrepodoc",
"Homepage": "https://github.com/TralahM/tekrepodoc",
"Source": "https://github.com/TralahM/tekrepodoc",
"Tracker": "https://github.com/TralahM/tekrepodoc/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb1efc72eeffa13911d9d71bef83f908c4b228f81d62d5e25076d53be6c778e6",
"md5": "0ab3b0163e02b839c0a2786ab5ea4e32",
"sha256": "e1b5a60ab8fe2162d26e0652921f2897235ab3dcb0bfc2dd5f194e4bb417231f"
},
"downloads": -1,
"filename": "tekrepodoc-0.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ab3b0163e02b839c0a2786ab5ea4e32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 111478,
"upload_time": "2023-08-12T13:14:57",
"upload_time_iso_8601": "2023-08-12T13:14:57.298871Z",
"url": "https://files.pythonhosted.org/packages/cb/1e/fc72eeffa13911d9d71bef83f908c4b228f81d62d5e25076d53be6c778e6/tekrepodoc-0.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-12 13:14:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TralahM",
"github_project": "tekrepodoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tekrepodoc"
}
