README GENERATOR AND VALIDATOR FOR ODOO
=======================================
This plugin is based on oca-gen-addon-readme from the repository [OCA/maintainer-tools.git](https://github.com/OCA/maintainer-tools). The original version is licensed under AGPL-3.
You can find the terms of the license in the LICENSE file available in this repository.
This small utility generates high-quality README.rst files along with a web page, which is displayed when reviewing the module's information. The webpage is located in the static/index.html directory.
The README generation starts by creating a readme directory in the module, containing a number of .rst files called *Fractions* where the developer can describe the module's functionalities in detail.
tony_stark_module
├── views
├── readme
| ├── CONFIGURE.rst
| ├── CONTRIBUTORS.rst
| ├── CREDITS.rst
| ├── DESCRIPTION.rst
| ├── HISTORY.rst
| ├── INSTALL.rst
| ├── READMAP.rst
| └── USAGE.rst
├── reports
├── static
└── views
What gen_readme does:
---------------------
1. If the readme directory does not exist in the module, gen-readme will create the directory in situ, with all the fragments plus an empty README.
1. Make sure that the CONTRIBUTORS.rst section includes the developer(s) who created or modified the module, as there may be multiple authors.
1. Ensure that the word count in the DESCRIPTION section is at a reasonable level. This can be adjusted using a parameter.
1. Check that the module's manifest contains the author key, which usually refers to the intellectual property owner, typically the partner.
1. Additionally, at the request of Raiver Figueroa, ensure that the module has an icon.
pre-commit hook
---------------
You can use this module as a pre-commit plugin this way
- repo: https://github.com/quilsoft-org/gen-readme.git
rev: 1.3.53
hooks:
- id: gen-readme
args:
- --min-description-words=20
- --website=https://quilsoft.com
- --org-name=quilsoft-org
- --author=Quilsoft
Local Installation
------------------
You can install the plugin locally and run it against a set of modules. To do this, you need to install it with:
sudo pipx install gen-odoo-readme
See proyect details in [pypi.org/gen-odoo/readme](https://pypi.org/project/gen-odoo-readme/)
Use the gen-readme --help command for detailed usage instructions:
Usage: gen_readme.py [OPTIONS] [FILES]...
main function for gen_readme
Options:
--addons DIRECTORY Directory containing several addons, the
README will be generated for all installable
addons found there...
--min-description-words INTEGER
Minimum number of words that the DESCRIPTION
section must contain. Default: 40
--website TEXT Partner website; the logo at the end of the
README is taken from this website
--org-name TEXT Github Organization from the partner.
Default: quilsoft-org
--author TEXT Tipically the intelectual author of the
module Default: Quilsoft
--help Show this message and exit.
When working locally, you must provide the --addons-dir DIRECTORY option to make it work
Raw data
{
"_id": null,
"home_page": "https://github.com/jobiols/gen-readme",
"name": "gen-odoo-readme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "odoo documentation readme rst",
"author": "Jorge E. Obiols",
"author_email": "jorge.obiols@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fe/8e/ecfaf1cd1100bc6847455a1300da2dee4d1d223962889471bbfcee8ad48f/gen_odoo_readme-1.3.58.tar.gz",
"platform": null,
"description": "\nREADME GENERATOR AND VALIDATOR FOR ODOO\n=======================================\n\nThis plugin is based on oca-gen-addon-readme from the repository [OCA/maintainer-tools.git](https://github.com/OCA/maintainer-tools). The original version is licensed under AGPL-3.\n\nYou can find the terms of the license in the LICENSE file available in this repository.\n\nThis small utility generates high-quality README.rst files along with a web page, which is displayed when reviewing the module's information. The webpage is located in the static/index.html directory.\n\nThe README generation starts by creating a readme directory in the module, containing a number of .rst files called *Fractions* where the developer can describe the module's functionalities in detail.\n\n\n tony_stark_module\n \u251c\u2500\u2500 views\n \u251c\u2500\u2500 readme\n | \u251c\u2500\u2500 CONFIGURE.rst\n | \u251c\u2500\u2500 CONTRIBUTORS.rst\n | \u251c\u2500\u2500 CREDITS.rst\n | \u251c\u2500\u2500 DESCRIPTION.rst\n | \u251c\u2500\u2500 HISTORY.rst\n | \u251c\u2500\u2500 INSTALL.rst\n | \u251c\u2500\u2500 READMAP.rst\n | \u2514\u2500\u2500 USAGE.rst\n \u251c\u2500\u2500 reports\n \u251c\u2500\u2500 static\n \u2514\u2500\u2500 views\n\nWhat gen_readme does:\n---------------------\n\n1. If the readme directory does not exist in the module, gen-readme will create the directory in situ, with all the fragments plus an empty README.\n1. Make sure that the CONTRIBUTORS.rst section includes the developer(s) who created or modified the module, as there may be multiple authors.\n1. Ensure that the word count in the DESCRIPTION section is at a reasonable level. This can be adjusted using a parameter.\n1. Check that the module's manifest contains the author key, which usually refers to the intellectual property owner, typically the partner.\n1. Additionally, at the request of Raiver Figueroa, ensure that the module has an icon.\n\npre-commit hook\n---------------\n\nYou can use this module as a pre-commit plugin this way\n\n - repo: https://github.com/quilsoft-org/gen-readme.git\n rev: 1.3.53\n hooks:\n - id: gen-readme\n args:\n - --min-description-words=20\n - --website=https://quilsoft.com\n - --org-name=quilsoft-org\n - --author=Quilsoft\n\nLocal Installation\n------------------\n\nYou can install the plugin locally and run it against a set of modules. To do this, you need to install it with:\n\n sudo pipx install gen-odoo-readme\n\nSee proyect details in [pypi.org/gen-odoo/readme](https://pypi.org/project/gen-odoo-readme/)\n\nUse the gen-readme --help command for detailed usage instructions:\n\n Usage: gen_readme.py [OPTIONS] [FILES]...\n\n main function for gen_readme\n\n Options:\n --addons DIRECTORY Directory containing several addons, the\n README will be generated for all installable\n addons found there...\n --min-description-words INTEGER\n Minimum number of words that the DESCRIPTION\n section must contain. Default: 40\n --website TEXT Partner website; the logo at the end of the\n README is taken from this website\n --org-name TEXT Github Organization from the partner.\n Default: quilsoft-org\n --author TEXT Tipically the intelectual author of the\n module Default: Quilsoft\n --help Show this message and exit.\n\nWhen working locally, you must provide the --addons-dir DIRECTORY option to make it work\n",
"bugtrack_url": null,
"license": null,
"summary": "Tool to create README.rst files for Odoo",
"version": "1.3.58",
"project_urls": {
"Homepage": "https://github.com/jobiols/gen-readme"
},
"split_keywords": [
"odoo",
"documentation",
"readme",
"rst"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1c3e4cddedbe830cbe7aec5eb1acb74fb02943bebbbd1f005755077f52d3c2cd",
"md5": "91e029658cab089359fd02fe162a4076",
"sha256": "8115a2d07ecd5338d9141322c0f9ffb920ea3602c4ea6924e249dda793f82f1e"
},
"downloads": -1,
"filename": "gen_odoo_readme-1.3.58-py3-none-any.whl",
"has_sig": false,
"md5_digest": "91e029658cab089359fd02fe162a4076",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22981,
"upload_time": "2024-09-13T21:29:23",
"upload_time_iso_8601": "2024-09-13T21:29:23.041800Z",
"url": "https://files.pythonhosted.org/packages/1c/3e/4cddedbe830cbe7aec5eb1acb74fb02943bebbbd1f005755077f52d3c2cd/gen_odoo_readme-1.3.58-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe8eecfaf1cd1100bc6847455a1300da2dee4d1d223962889471bbfcee8ad48f",
"md5": "805b323b6b08997dcc15fa7246000d5c",
"sha256": "9d15e3972c48e39a69bf2b73a37643293300a9dfe491cc2df0e24a3191f217e0"
},
"downloads": -1,
"filename": "gen_odoo_readme-1.3.58.tar.gz",
"has_sig": false,
"md5_digest": "805b323b6b08997dcc15fa7246000d5c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20521,
"upload_time": "2024-09-13T21:29:24",
"upload_time_iso_8601": "2024-09-13T21:29:24.020446Z",
"url": "https://files.pythonhosted.org/packages/fe/8e/ecfaf1cd1100bc6847455a1300da2dee4d1d223962889471bbfcee8ad48f/gen_odoo_readme-1.3.58.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 21:29:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jobiols",
"github_project": "gen-readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gen-odoo-readme"
}
JSON
