<img align="right" src="https://raw.githubusercontent.com/vroncevic/gen_readme/dev/docs/gen_readme_logo.png" width="25%">
# Create README.md doc module
**gen_readme** is tool for creating README.md doc module.
Developed in **[python](https://www.python.org/)** code.
The README is used to introduce the modules and provide instructions on
how to install the modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.
[](https://github.com/vroncevic/gen_readme/actions/workflows/gen_readme_python_checker.yml) [](https://github.com/vroncevic/gen_readme/actions/workflows/gen_readme_package.yml) [](https://github.com/vroncevic/gen_readme/issues) [](https://github.com/vroncevic/gen_readme/graphs/contributors)
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using build](#install-using-build)
- [Install using py setup](#install-using-py-setup)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and licence](#copyright-and-licence)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
### Installation
[](https://github.com/vroncevic/gen_readme/actions/workflows/gen_readme_python3_build.yml)
Currently there are three ways to install package
* Install process based on using pip mechanism
* Install process based on build mechanism
* Install process based on setup.py mechanism
* Install process based on docker mechanism
##### Install using pip
Python package is located at **[pypi.org](https://pypi.org/project/gen_readme/)**.
You can install by using pip
```bash
#python3
pip3 install gen_readme
```
##### Install using build
Navigate to release **[page](https://github.com/vroncevic/gen_readme/releases/)** download and extract release archive.
To install **gen_readme** type the following
```bash
tar xvzf gen_readme-x.y.z.tar.gz
cd gen_readme-x.y.z/
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install ./dist/gen_readme-*-py3-none-any.whl
rm -f get-pip.py
chmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_readme_run.py
ln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_readme_run.py /usr/local/bin/gen_readme_run.py
```
##### Install using py setup
Navigate to **[release page](https://github.com/vroncevic/gen_readme/releases)** download and extract release archive.
To install **gen_readme** locate and run setup.py, type the following
```bash
tar xvzf gen_readme-x.y.z.tar.gz
cd gen_readme-x.y.z
#python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
python3 setup.py install_data
```
##### Install using docker
You can use Dockerfile to create image/container.
### Dependencies
**gen_readme** requires next modules and libraries
- [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/ats_utilities)
### Tool structure
**gen_readme** is based on OOP
Generator structure
```bash
gen_readme/
├── conf/
│ ├── gen_readme.cfg
│ ├── gen_readme.logo
│ ├── gen_readme_util.cfg
│ ├── project.yaml
│ └── template/
│ ├── README_AVR.template
│ ├── README_CC.template
│ ├── README_C.template
│ ├── README_JS.template
│ ├── README_PL.template
│ ├── README_PY.template
│ ├── README_RPI.template
│ ├── README_SH.template
│ ├── README_STM.template
│ └── README_VALA.template
├── __init__.py
├── log/
│ └── gen_readme.log
├── pro/
│ ├── __init__.py
│ ├── read_template.py
│ └── write_template.py
└── run/
└── gen_readme_run.py
6 directories, 20 files
```
### Code coverage
| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_readme/__init__.py` | 75 | 14 | 81% |
| `gen_readme/pro/__init__.py` | 62 | 2 | 97% |
| `gen_readme/pro/read_template.py` | 52 | 5 | 90% |
| `gen_readme/pro/write_template.py` | 50 | 2 | 96% |
| **Total** | 239 | 23 | 90% |
### Docs
[](https://gen-readme.readthedocs.io/en/latest/?badge=latest)
More documentation and info at
* [gen_readme.readthedocs.io](https://gen-readme.readthedocs.io)
* [www.python.org](https://www.python.org/)
### Contributing
[Contributing to gen_readme](CONTRIBUTING.md)
### Copyright and licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2020 - 2024 by [vroncevic.github.io/gen_readme](https://vroncevic.github.io/gen_readme/)
**gen_readme** is free software; you can redistribute it and/or modify
it under the same terms as Python itself, either Python version 3.x or,
at your option, any later version of Python 3 you may have available.
Lets help and support PSF.
[](https://www.python.org/psf/)
[](https://www.python.org/psf/donations/)
Raw data
{
"_id": null,
"home_page": "https://vroncevic.github.io/gen_readme/",
"name": "gen-readme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Readme, README, project, Unix, Linux, Docs",
"author": "Vladimir Roncevic",
"author_email": "elektron.ronca@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a3/ff/03e7647a18406a13f39932a98301ac0b6bc69ebf009b6b686bffe5752b19/gen_readme-1.1.3.tar.gz",
"platform": "POSIX",
"description": "<img align=\"right\" src=\"https://raw.githubusercontent.com/vroncevic/gen_readme/dev/docs/gen_readme_logo.png\" width=\"25%\">\n\n# Create README.md doc module\n\n**gen_readme** is tool for creating README.md doc module.\n\nDeveloped in **[python](https://www.python.org/)** code.\n\nThe README is used to introduce the modules and provide instructions on\nhow to install the modules, any machine dependencies it may have and any\nother information that should be provided before the modules are installed.\n\n[](https://github.com/vroncevic/gen_readme/actions/workflows/gen_readme_python_checker.yml) [](https://github.com/vroncevic/gen_readme/actions/workflows/gen_readme_package.yml) [](https://github.com/vroncevic/gen_readme/issues) [](https://github.com/vroncevic/gen_readme/graphs/contributors)\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n**Table of Contents**\n\n- [Installation](#installation)\n - [Install using pip](#install-using-pip)\n - [Install using build](#install-using-build)\n - [Install using py setup](#install-using-py-setup)\n - [Install using docker](#install-using-docker)\n- [Dependencies](#dependencies)\n- [Tool structure](#tool-structure)\n- [Docs](#docs)\n- [Contributing](#contributing)\n- [Copyright and licence](#copyright-and-licence)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n### Installation\n\n\n\n[](https://github.com/vroncevic/gen_readme/actions/workflows/gen_readme_python3_build.yml)\n\nCurrently there are three ways to install package\n* Install process based on using pip mechanism\n* Install process based on build mechanism\n* Install process based on setup.py mechanism\n* Install process based on docker mechanism\n\n##### Install using pip\n\nPython package is located at **[pypi.org](https://pypi.org/project/gen_readme/)**.\n\nYou can install by using pip\n\n```bash\n#python3\npip3 install gen_readme\n```\n\n##### Install using build\n\nNavigate to release **[page](https://github.com/vroncevic/gen_readme/releases/)** download and extract release archive.\n\nTo install **gen_readme** type the following\n\n```bash\ntar xvzf gen_readme-x.y.z.tar.gz\ncd gen_readme-x.y.z/\n# python3\nwget https://bootstrap.pypa.io/get-pip.py\npython3 get-pip.py \npython3 -m pip install --upgrade setuptools\npython3 -m pip install --upgrade pip\npython3 -m pip install --upgrade build\npip3 install -r requirements.txt\npython3 -m build --no-isolation --wheel\npip3 install ./dist/gen_readme-*-py3-none-any.whl\nrm -f get-pip.py\nchmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_readme_run.py\nln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_readme_run.py /usr/local/bin/gen_readme_run.py\n```\n\n##### Install using py setup\n\nNavigate to **[release page](https://github.com/vroncevic/gen_readme/releases)** download and extract release archive.\n\nTo install **gen_readme** locate and run setup.py, type the following\n\n```bash\ntar xvzf gen_readme-x.y.z.tar.gz\ncd gen_readme-x.y.z\n#python3\npip3 install -r requirements.txt\npython3 setup.py install_lib\npython3 setup.py install_egg_info\npython3 setup.py install_data\n```\n\n##### Install using docker\n\nYou can use Dockerfile to create image/container.\n\n### Dependencies\n\n**gen_readme** requires next modules and libraries\n\n- [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/ats_utilities)\n\n### Tool structure\n\n**gen_readme** is based on OOP\n\nGenerator structure\n\n```bash\n gen_readme/\n \u251c\u2500\u2500 conf/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_readme.cfg\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_readme.logo\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_readme_util.cfg\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 project.yaml\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 template/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_AVR.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_CC.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_C.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_JS.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_PL.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_PY.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_RPI.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_SH.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 README_STM.template\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 README_VALA.template\n \u251c\u2500\u2500 __init__.py\n \u251c\u2500\u2500 log/\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 gen_readme.log\n \u251c\u2500\u2500 pro/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 read_template.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 write_template.py\n \u2514\u2500\u2500 run/\n \u2514\u2500\u2500 gen_readme_run.py\n \n 6 directories, 20 files\n```\n### Code coverage\n\n| Name | Stmts | Miss | Cover |\n|------|-------|------|-------|\n| `gen_readme/__init__.py` | 75 | 14 | 81% |\n| `gen_readme/pro/__init__.py` | 62 | 2 | 97% |\n| `gen_readme/pro/read_template.py` | 52 | 5 | 90% |\n| `gen_readme/pro/write_template.py` | 50 | 2 | 96% |\n| **Total** | 239 | 23 | 90% |\n\n### Docs\n\n[](https://gen-readme.readthedocs.io/en/latest/?badge=latest)\n\nMore documentation and info at\n\n* [gen_readme.readthedocs.io](https://gen-readme.readthedocs.io)\n* [www.python.org](https://www.python.org/)\n\n### Contributing\n\n[Contributing to gen_readme](CONTRIBUTING.md)\n\n### Copyright and licence\n\n[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)\n\nCopyright (C) 2020 - 2024 by [vroncevic.github.io/gen_readme](https://vroncevic.github.io/gen_readme/)\n\n**gen_readme** is free software; you can redistribute it and/or modify\nit under the same terms as Python itself, either Python version 3.x or,\nat your option, any later version of Python 3 you may have available.\n\nLets help and support PSF.\n\n[](https://www.python.org/psf/)\n\n[](https://www.python.org/psf/donations/)\n",
"bugtrack_url": null,
"license": "GPL 2024 Free software to use and distributed it.",
"summary": "Readme doc generator",
"version": "1.1.3",
"project_urls": {
"Homepage": "https://vroncevic.github.io/gen_readme/"
},
"split_keywords": [
"readme",
" readme",
" project",
" unix",
" linux",
" docs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8dee363a8290d8c4604a41cc35b551f6ad4b0aa5b762b6cb133f040b7b6bd6e5",
"md5": "563f2824f0305f3fe718ee8a80c2909e",
"sha256": "d93a8829fc29bd5037bd7a0082df72e4db81216cada807d38680bcde1e9d9478"
},
"downloads": -1,
"filename": "gen_readme-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "563f2824f0305f3fe718ee8a80c2909e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 40974,
"upload_time": "2024-07-09T16:40:52",
"upload_time_iso_8601": "2024-07-09T16:40:52.361996Z",
"url": "https://files.pythonhosted.org/packages/8d/ee/363a8290d8c4604a41cc35b551f6ad4b0aa5b762b6cb133f040b7b6bd6e5/gen_readme-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3ff03e7647a18406a13f39932a98301ac0b6bc69ebf009b6b686bffe5752b19",
"md5": "0269104a90597db9574b815fc448a51c",
"sha256": "40ef51f4f0b56363dd367c75025f4352b303f326ba730e68522b22a9f3b1e247"
},
"downloads": -1,
"filename": "gen_readme-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "0269104a90597db9574b815fc448a51c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 26857,
"upload_time": "2024-07-09T16:40:55",
"upload_time_iso_8601": "2024-07-09T16:40:55.399783Z",
"url": "https://files.pythonhosted.org/packages/a3/ff/03e7647a18406a13f39932a98301ac0b6bc69ebf009b6b686bffe5752b19/gen_readme-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 16:40:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gen-readme"
}
JSON