{"id":20130009,"url":"https://github.com/tralahm/tekrepodoc","last_synced_at":"2025-07-10T10:41:57.539Z","repository":{"id":57473825,"uuid":"312472589","full_name":"TralahM/tekrepodoc","owner":"TralahM","description":"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.","archived":false,"fork":false,"pushed_at":"2023-08-12T13:15:52.000Z","size":180,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T16:13:15.522Z","etag":null,"topics":["cli","generator-template","jinja2-templates","pypi-package","sphinx-doc","template-engine","tralahm","tralahtek","yaml-configuration"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TralahM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.rst","funding":null,"license":null,"code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null},"funding":{"github":"TralahM","custom":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=WFKVHBRCYEE6S\u0026source=url","https://liberapay.com/TralahM/donate"]}},"created_at":"2020-11-13T04:25:34.000Z","updated_at":"2023-01-23T18:52:24.000Z","dependencies_parsed_at":"2023-01-25T23:45:13.563Z","dependency_job_id":null,"html_url":"https://github.com/TralahM/tekrepodoc","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TralahM%2Ftekrepodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TralahM%2Ftekrepodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TralahM%2Ftekrepodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TralahM%2Ftekrepodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TralahM","download_url":"https://codeload.github.com/TralahM/tekrepodoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065282,"owners_count":21041872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","generator-template","jinja2-templates","pypi-package","sphinx-doc","template-engine","tralahm","tralahtek","yaml-configuration"],"created_at":"2024-11-13T20:37:04.835Z","updated_at":"2025-04-09T16:13:26.644Z","avatar_url":"https://github.com/TralahM.png","language":"Python","funding_links":["https://github.com/sponsors/TralahM","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=WFKVHBRCYEE6S\u0026source=url","https://liberapay.com/TralahM/donate"],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://img.shields.io/github/license/TralahM/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/github/last-commit/TralahM/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/github/contributors/TralahM/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/github/issues-pr-raw/TralahM/tekrepodoc?color=blue\"\u003e \u003cimg src=\"https://img.shields.io/github/issues-pr-closed-raw/TralahM/tekrepodoc?color=red\"\u003e \u003cimg src=\"https://img.shields.io/github/issues-raw/TralahM/tekrepodoc?color=green\"\u003e \u003cimg src=\"https://img.shields.io/github/issues-closed-raw/TralahM/tekrepodoc?color=yellow\"\u003e \u003cimg src=\"https://img.shields.io/github/forks/TralahM/tekrepodoc?label=Forks\u0026style=social\"\u003e \u003cimg src=\"https://img.shields.io/github/forks/TralahM/tekrepodoc?label=Forks\u0026style=social\"\u003e \u003cimg src=\"https://img.shields.io/github/stars/TralahM/tekrepodoc?style=social\"\u003e \u003cimg src=\"https://img.shields.io/github/watchers/TralahM/tekrepodoc?label=Watch\u0026style=social\"\u003e \u003cimg src=\"https://img.shields.io/github/downloads/TralahM/tekrepodoc/total\"\u003e \u003cimg src=\"https://img.shields.io/github/repo-size/TralahM/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/github/languages/count/TralahM/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/github/v/tag/TralahM/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/readthedocs/tekrepodoc\"\u003e\n\u003cimg src=\"https://img.shields.io/pypi/v/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/pypi/pyversions/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/pypi/wheel/tekrepodoc\"\u003e \u003cimg src=\"https://img.shields.io/pypi/status/tekrepodoc?label=pypi%20status\"\u003e \u003cimg src=\"https://img.shields.io/pypi/format/tekrepodoc?label=pypi%20format\"\u003e\n\n# tekrepodoc\n\u003e 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) \u003cmusyoki.brian@tralahtek.com\u003e. Project:\n\u003chttps://github.com/TralahM/tekrepodoc\u003e\n```\n\n### First Generate a Configuration File\n\n```console\nrepodoc config --init\n\n```\n\n## Documentation\n\n[![Documentation](https://img.shields.io/badge/Docs-tekrepodoc-blue.svg?style=for-the-badge)](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[![TralahTek](https://img.shields.io/badge/Organization-TralahTek-black.svg?style=for-the-badge\u0026logo=github)](https://github.com/TralahTek)\n[![TralahM](https://img.shields.io/badge/Engineer-TralahM-blue.svg?style=for-the-badge\u0026logo=github)](https://github.com/TralahM)\n[![TralahM](https://img.shields.io/badge/Maintainer-TralahM-green.svg?style=for-the-badge\u0026logo=github)](https://github.com/TralahM)\n\n\n\n[![](https://img.shields.io/badge/Github-TralahM-green?style=for-the-badge\u0026logo=github)](https://github.com/TralahM)\n[![](https://img.shields.io/badge/Twitter-%40tralahtek-blue?style=for-the-badge\u0026logo=twitter)](https://twitter.com/TralahM)\n[![TralahM](https://img.shields.io/badge/Kaggle-TralahM-purple.svg?style=for-the-badge\u0026logo=kaggle)](https://kaggle.com/TralahM)\n[![TralahM](https://img.shields.io/badge/LinkedIn-TralahM-white.svg?style=for-the-badge\u0026logo=linkedin)](https://linkedin.com/in/TralahM)\n\n\n[![Blog](https://img.shields.io/badge/Blog-tralahm.tralahtek.com-blue.svg?style=for-the-badge\u0026logo=rss)](https://tralahm.tralahtek.com)\n\n[![TralahTek](https://img.shields.io/badge/Organization-TralahTek-cyan.svg?style=for-the-badge)](https://org.tralahtek.com)\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftralahm%2Ftekrepodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftralahm%2Ftekrepodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftralahm%2Ftekrepodoc/lists"}