| Name | odooer JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | None |
| Summary | A CLI tool for creating Odoo module boilerplate |
| upload_time | 2024-04-07 20:07:24 |
| maintainer | None |
| docs_url | None |
| author | Muhammad Osama |
| requires_python | None |
| license | None |
| keywords |
odoo
cli
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Odooer
## Overview
Odooer is a CLI tool designed to streamline the development of Odoo modules by automating the boilerplate creation process. It facilitates the quick setup of new modules or the extension of existing ones, ensuring that developers can focus more on functionality rather than setup procedures.
## Features
- **Module Creation**: Easily generate a new Odoo module with a standard directory structure, including models, views, and security settings.
- **Inheritance Support**: Extend existing Odoo modules with custom functionality by inheriting from them directly through the CLI.
- **Automatic File Generation**: Automatically creates essential files like `__init__.py`, `model.py`, `__manifest__.py`, and `ir.model.access.csv`, along with basic templates to get you started.
## Installation
Odooer can be installed via pip. Ensure you have Python installed on your system before proceeding.
```bash
pip install odooer
```
## Usage
Odooer simplifies the creation of Odoo modules with two primary commands: `create` and `inherit`.
### Creating a New Module
To create a new module, run the following command:
```bash
odooer create <module_name>
```
This command sets up a new module with a basic structure, including model and view directories, and initializes files necessary for Odoo modules.
### Inheriting From an Existing Module
To extend an existing module with additional functionality, use:
```bash
odooer inherit <module_name_to_inherit> <your_module_name>
```
This creates a new module that inherits from an existing one, allowing you to extend or override functionality as needed.
## Project Structure
Odooer generates the following structure for a new module:
- **/models**: Contains `model.py` with a template for model definition.
- **/views**: Includes `module_view.xml` for defining UI elements.
- **/security**: (Optional) Holds `ir.model.access.csv` for access rights configuration, not created when inheriting.
- **`__init__.py`**: Autogenerated to import models.
- **`__manifest__.py`**: Contains module metadata, dependencies, and data files.
## Contributing
Contributions to the Odooer project are welcome. Whether it's bug reports, feature suggestions, or code contributions, please feel free to reach out.
## Contact
- **Author**: Muhammad Osama
- **Linkedin**: https://www.linkedin.com/in/ocama-mohamed
- **Email**: ocama_aslam@outlook.com
Raw data
{
"_id": null,
"home_page": null,
"name": "odooer",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Odoo CLI",
"author": "Muhammad Osama",
"author_email": "ocama_aslam@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/7f/df/11a0072b9e658693f904676b93300b69942038a53135bc886e3239567018/odooer-1.0.3.tar.gz",
"platform": null,
"description": "# Odooer\n\n## Overview\nOdooer is a CLI tool designed to streamline the development of Odoo modules by automating the boilerplate creation process. It facilitates the quick setup of new modules or the extension of existing ones, ensuring that developers can focus more on functionality rather than setup procedures.\n\n## Features\n- **Module Creation**: Easily generate a new Odoo module with a standard directory structure, including models, views, and security settings.\n- **Inheritance Support**: Extend existing Odoo modules with custom functionality by inheriting from them directly through the CLI.\n- **Automatic File Generation**: Automatically creates essential files like `__init__.py`, `model.py`, `__manifest__.py`, and `ir.model.access.csv`, along with basic templates to get you started.\n\n## Installation\nOdooer can be installed via pip. Ensure you have Python installed on your system before proceeding.\n\n```bash\npip install odooer\n```\n\n## Usage\nOdooer simplifies the creation of Odoo modules with two primary commands: `create` and `inherit`.\n\n### Creating a New Module\nTo create a new module, run the following command:\n\n```bash\nodooer create <module_name>\n```\n\nThis command sets up a new module with a basic structure, including model and view directories, and initializes files necessary for Odoo modules.\n\n### Inheriting From an Existing Module\nTo extend an existing module with additional functionality, use:\n\n```bash\nodooer inherit <module_name_to_inherit> <your_module_name>\n```\n\nThis creates a new module that inherits from an existing one, allowing you to extend or override functionality as needed.\n\n## Project Structure\nOdooer generates the following structure for a new module:\n\n- **/models**: Contains `model.py` with a template for model definition.\n- **/views**: Includes `module_view.xml` for defining UI elements.\n- **/security**: (Optional) Holds `ir.model.access.csv` for access rights configuration, not created when inheriting.\n- **`__init__.py`**: Autogenerated to import models.\n- **`__manifest__.py`**: Contains module metadata, dependencies, and data files.\n\n## Contributing\nContributions to the Odooer project are welcome. Whether it's bug reports, feature suggestions, or code contributions, please feel free to reach out.\n\n## Contact\n- **Author**: Muhammad Osama\n- **Linkedin**: https://www.linkedin.com/in/ocama-mohamed\n- **Email**: ocama_aslam@outlook.com\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI tool for creating Odoo module boilerplate",
"version": "1.0.3",
"project_urls": null,
"split_keywords": [
"odoo",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0335c499cd628ef584b33996b3aa735153bdd382a3ed78e22371fad03c269492",
"md5": "4e36ae92c65d65d1066323e7ec093897",
"sha256": "d78a513dae0867e51d01ac4e04bc3ef027dce0b8dfe5651d0533ea4391291552"
},
"downloads": -1,
"filename": "odooer-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e36ae92c65d65d1066323e7ec093897",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3906,
"upload_time": "2024-04-07T20:07:22",
"upload_time_iso_8601": "2024-04-07T20:07:22.963049Z",
"url": "https://files.pythonhosted.org/packages/03/35/c499cd628ef584b33996b3aa735153bdd382a3ed78e22371fad03c269492/odooer-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7fdf11a0072b9e658693f904676b93300b69942038a53135bc886e3239567018",
"md5": "98ebebfcd44fd2ab567a9775a7a1d220",
"sha256": "8fe8afe5851dc0cccf200a7266e2118d12f3b5a6be2369cf387157009c5c4e35"
},
"downloads": -1,
"filename": "odooer-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "98ebebfcd44fd2ab567a9775a7a1d220",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3546,
"upload_time": "2024-04-07T20:07:24",
"upload_time_iso_8601": "2024-04-07T20:07:24.433267Z",
"url": "https://files.pythonhosted.org/packages/7f/df/11a0072b9e658693f904676b93300b69942038a53135bc886e3239567018/odooer-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 20:07:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "odooer"
}
