# Odoolint
Odoolint is a comprehensive linting tool designed specifically for Odoo modules. It helps developers maintain code quality and consistency across their Odoo projects by performing various checks on Python files, XML files, and other web assets.
## Features
- Python code style checking using Flake8
- XML ID duplication detection within Odoo modules
- End-of-file newline validation for various file types
## Installation
You can install Odoolint using pip:
```
pip install odoolint
```
## Usage
Run Odoolint from the command line in your Odoo project directory:
```
odoolint
```
Odoolint will automatically look for a `.odoolint` configuration file in the current directory. If no configuration file is found, default settings will be used.
## Configuration
Create a `.odoolint` file in YAML format in your project's root directory to customize Odoolint's behavior. Here's an example configuration:
```yaml
flake8_select: "C,E,F,W,B,B9,N801,N803"
flake8_ignore: "E203,E501,W503,C901,W605,E722,E731"
flake8_exclude:
- "**unported**"
- "**__init__.py"
- "tests"
check_file_types:
- ".xml"
- ".js"
- ".css"
- ".scss"
- ".csv"
```
### Configuration Options
- `flake8_select`: Comma-separated list of error codes to check for in Python files.
- `flake8_ignore`: Comma-separated list of error codes to ignore in Python files.
- `flake8_exclude`: List of file or directory patterns to exclude from checks.
- `check_file_types`: List of file extensions to check for end-of-file newlines.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/dgperp/odoolint",
"name": "odoolint",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.6",
"maintainer_email": null,
"keywords": "odoo, linter, development, tools",
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/15/61/119c3950089624ce98509f0cef3ba93af80f49a51529708ea00d0c30d8d1/odoolint-1.0.9.tar.gz",
"platform": null,
"description": "# Odoolint\n\nOdoolint is a comprehensive linting tool designed specifically for Odoo modules. It helps developers maintain code quality and consistency across their Odoo projects by performing various checks on Python files, XML files, and other web assets.\n\n## Features\n\n- Python code style checking using Flake8\n- XML ID duplication detection within Odoo modules\n- End-of-file newline validation for various file types\n\n## Installation\n\nYou can install Odoolint using pip:\n\n```\npip install odoolint\n```\n\n## Usage\n\nRun Odoolint from the command line in your Odoo project directory:\n\n```\nodoolint\n```\n\nOdoolint will automatically look for a `.odoolint` configuration file in the current directory. If no configuration file is found, default settings will be used.\n\n## Configuration\n\nCreate a `.odoolint` file in YAML format in your project's root directory to customize Odoolint's behavior. Here's an example configuration:\n\n```yaml\nflake8_select: \"C,E,F,W,B,B9,N801,N803\"\nflake8_ignore: \"E203,E501,W503,C901,W605,E722,E731\"\nflake8_exclude:\n - \"**unported**\"\n - \"**__init__.py\"\n - \"tests\"\ncheck_file_types:\n - \".xml\"\n - \".js\"\n - \".css\"\n - \".scss\"\n - \".csv\"\n```\n\n### Configuration Options\n\n- `flake8_select`: Comma-separated list of error codes to check for in Python files.\n- `flake8_ignore`: Comma-separated list of error codes to ignore in Python files.\n- `flake8_exclude`: List of file or directory patterns to exclude from checks.\n- `check_file_types`: List of file extensions to check for end-of-file newlines.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A comprehensive linting tool for Odoo modules",
"version": "1.0.9",
"project_urls": {
"Bug Reports": "https://github.com/dgperp/odoolint/issues",
"Homepage": "https://github.com/dgperp/odoolint",
"Source": "https://github.com/dgperp/odoolint/"
},
"split_keywords": [
"odoo",
" linter",
" development",
" tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "150abce7298422612a5721a2671e95b9f842060d74f4eb2f7bee14ed1e286ab7",
"md5": "4b222dcbcae67f226fb58cdc9babb0f9",
"sha256": "b5212159faaccf61497a48de9984066cb788be9b423275c888a1c2aaffa9c6e4"
},
"downloads": -1,
"filename": "odoolint-1.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b222dcbcae67f226fb58cdc9babb0f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.6",
"size": 6561,
"upload_time": "2024-10-19T08:29:02",
"upload_time_iso_8601": "2024-10-19T08:29:02.571244Z",
"url": "https://files.pythonhosted.org/packages/15/0a/bce7298422612a5721a2671e95b9f842060d74f4eb2f7bee14ed1e286ab7/odoolint-1.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1561119c3950089624ce98509f0cef3ba93af80f49a51529708ea00d0c30d8d1",
"md5": "441aea6a3f66eeb2ed15292b1e098b50",
"sha256": "2c7d12870e7f1d71db129aa3208515110d70879fb61ceb2cd2f12da486eb0e4c"
},
"downloads": -1,
"filename": "odoolint-1.0.9.tar.gz",
"has_sig": false,
"md5_digest": "441aea6a3f66eeb2ed15292b1e098b50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.6",
"size": 4946,
"upload_time": "2024-10-19T08:29:03",
"upload_time_iso_8601": "2024-10-19T08:29:03.911675Z",
"url": "https://files.pythonhosted.org/packages/15/61/119c3950089624ce98509f0cef3ba93af80f49a51529708ea00d0c30d8d1/odoolint-1.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-19 08:29:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dgperp",
"github_project": "odoolint",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "odoolint"
}
JSON
