odoo-addons-parser 0.5__tar.gz → 0.7__tar.gz

{odoo_addons_parser-0.5 → odoo_addons_parser-0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odoo-addons-parser
-Version: 0.5
+Version: 0.7
 Summary: Collect data from Odoo module folders.
 Author: Sébastien Alix
 License:                    GNU LESSER GENERAL PUBLIC LICENSE
@@ -173,36 +173,64 @@ Project-URL: homepage, https://github.com/sebalix/odoo-addons-parser
 Project-URL: documentation, https://github.com/sebalix/odoo-addons-parser
 Project-URL: repository, https://github.com/sebalix/odoo-addons-parser
 Keywords: odoo,oca,analyze,parser,collect,modules,addons
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Framework :: Odoo
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pygount<1.7.0
+Requires-Dist: tree-sitter>=0.20.0
+Requires-Dist: tree-sitter-python>=0.20.0
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: coverage; extra == "test"
 Dynamic: license-file
 
+# odoo-addons-parser
+
+[![Version](https://img.shields.io/pypi/v/odoo-addons-parser.svg?maxAge=86400)](https://pypi.org/project/odoo-addons-parser)
+[![Supported Versions](https://img.shields.io/pypi/pyversions/odoo-addons-parser.svg)](https://pypi.org/project/odoo-addons-parser)
 [![Pre-commit Status](https://github.com/sebalix/odoo-addons-parser/actions/workflows/pre-commit.yml/badge.svg?branch=main)](https://github.com/sebalix/odoo-addons-parser/actions/workflows/pre-commit.yml?query=branch%3Amain)
 [![Tests Status](https://github.com/sebalix/odoo-addons-parser/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sebalix/odoo-addons-parser/actions/workflows/test.yml?query=branch%3Amain)
-[![Last version](https://img.shields.io/pypi/v/odoo-addons-parser)](https://pypi.org/project/odoo-addons-parser/)
 
-# odoo-addons-parser
+Python package to collect and analyze data from Odoo module folders without requiring an Odoo runtime. It performs static file analysis to extract useful information from Odoo modules.
+
+## Features
+
+- **Static Analysis**: Doesn't rely on any Odoo runtime; performs static files analysis
+- **Code Statistics**: Count lines of code (Python, XML, JavaScript, and CSS)
+- **Manifest Parsing**: Extract useful data from manifest files (authors, dependencies, etc.)
+- **Model Extraction**: Extract Odoo models information (with fields and methods)
+- **Data Extraction**: Extract data from XML and CSV files
+- **Flexible Scanning**: Scan individual modules, repositories, or entire Odoo source code
 
-Python package to collect data from Odoo module folders.
+## Installation
 
-Features:
+```bash
+uv pip install odoo-addons-parser
+```
+
+Or with pip:
+```bash
+pip install odoo-addons-parser
+```
 
-- scan an Odoo repository, a folder of modules (repository) or a module only
-- count the number of lines of code (Python, XML, JavaScript and CSS by default)
-- read the manifest file (to get useful data like authors or dependencies)
-- extract Odoo models info (fields, methods...)
+## Usage
 
-## ModuleParser class
+### ModuleParser
 
-`ModuleParser` class aims to scan a module folder only:
+Parse a single Odoo module:
 
 ```python
 from odoo_addons_parser import ModuleParser
@@ -211,103 +239,73 @@ from pprint import pprint as pp
 mod = ModuleParser("/path/to/OCA/server-tools/server_environment")
 pp(mod.to_dict())
 ```
-=>
+
+Example output:
+
 ```python
-{'code': {'CSS': 0, 'JavaScript': 0, 'Python': 541, 'XML': 21},
- 'manifest': {'author': 'Camptocamp,Odoo Community Association (OCA)',
-              'category': 'Tools',
-              'data': ['security/ir.model.access.csv',
-                       'security/res_groups.xml',
-                       'serv_config.xml'],
-              'depends': ['base', 'base_sparse_field'],
-              'installable': True,
-              'license': 'GPL-3 or any later version',
-              'name': 'server configuration environment files',
-              'summary': 'move some configurations out of the database',
-              'version': '14.0.1.0.0',
-              'website': 'https://github.com/OCA/server-env'}},
- 'models': ...
- 'name': 'server_environment',
+{
+    'code': {'CSS': 0, 'JavaScript': 0, 'Python': 541, 'XML': 21},
+    'manifest': {
+        'author': 'Camptocamp,Odoo Community Association (OCA)',
+        'category': 'Tools',
+        'data': ['security/ir.model.access.csv', 'security/res_groups.xml', 'serv_config.xml'],
+        'depends': ['base', 'base_sparse_field'],
+        'installable': True,
+        'license': 'GPL-3 or any later version',
+        'name': 'server configuration environment files',
+        'summary': 'move some configurations out of the database',
+        'version': '14.0.1.0.0',
+        'website': 'https://github.com/OCA/server-env'
+    },
+    'models': ...,
+    'name': 'server_environment'
+}
 ```
 
-## RepositoryParser class
+### RepositoryParser
 
-`RepositoryParser` class aims to scan a whole repository of addons
-(also named *addons path*):
+Parse a whole repository of addons:
 
 ```python
 from odoo_addons_parser import RepositoryParser
+
 repo = RepositoryParser("/path/to/OCA/server-tools")
 pp(repo.to_dict())
 ```
-=>
-```python
-{'data_encryption': {'code': {'CSS': 0,
-                              'JavaScript': 0,
-                              'Python': 187,
-                              'XML': 0},
-                     'manifest': {'application': False,
-                                  'author': 'Akretion, Odoo Community '
-                                            'Association (OCA)',
-                                  'category': 'Tools',
-                                  'data': ['security/ir.model.access.csv'],
-                                  'depends': ['base'],
-                                  'development_status': 'Alpha',
-                                  'external_dependencies': {'python': ['cryptography']},
-                                  'installable': True,
-                                  'license': 'AGPL-3',
-                                  'name': 'Encryption data',
-                                  'summary': 'Store accounts and credentials '
-                                             'encrypted by environment',
-                                  'version': '14.0.1.0.0',
-                                  'website': 'https://github.com/OCA/server-env'},
-                     'models': ...,
-                     'name': 'data_encryption'},
- 'mail_environment': {'code': {'CSS': 0,
-                               'JavaScript': 0,
-                               'Python': 43,
-                               'XML': 0},
-                      'manifest': {'author': 'Camptocamp, Odoo Community '
-                                             'Association (OCA)',
-                                   'category': 'Tools',
-                                   'depends': ['fetchmail',
-                                               'server_environment'],
-                                   'license': 'AGPL-3',
-                                   'name': 'Mail configuration with '
-                                           'server_environment',
-                                   'summary': 'Configure mail servers with '
-                                              'server_environment_files',
-                                   'version': '14.0.1.0.0',
-                                   'website': 'https://github.com/OCA/server-env'},
-                     'models': ...,
-                     'name': 'mail_environment'},
-[...]
-```
 
-## OdooParser class
+### OdooParser
 
-`OdooParser` special class aims to scan the Odoo source code repository
-(the one we clone from https://github.com/odoo/odoo). It'll parse the content
-of `./odoo/addons`, `./addons` and Odoo base classes such as `BaseModel`,
-`Model` and `TransientModel`:
+Parse the Odoo source code repository:
 
 ```python
->>> from odoo_addons_parser import OdooParser
->>> odoo = OdooParser("/path/to/odoo/odoo")
->>> data = odoo.to_dict()
->>> list(data["__odoo__"]["models"])
-["BaseModel", "Model", "TransientModel"]
->>> "res.partner" in data["base"]["models"]
-True
+from odoo_addons_parser import OdooParser
+
+odoo = OdooParser("/path/to/odoo/odoo")
+data = odoo.to_dict()
+list(data["__odoo__"]["models"])
+# ["BaseModel", "Model", "TransientModel"]
+"res.partner" in data["base"]["models"]
+# True
 ```
 
 ## Parameters
 
-Code stats or models scanning can be disabled thanks to `code_stats` and
-`scan_models` parameters, available on all classes:
+You can disable specific features using parameters:
 
 ```python
+# Disable code statistics
 repo = RepositoryParser("path/to/addons_path", code_stats=False)
+
+# Disable model scanning
 mod = ModuleParser("path/to/addons_path/module", scan_models=False)
-odoo = OdooParser("path/to/odoo/odoo", code_stats=False)
+
+# Disable data scanning
+mod = ModuleParser("path/to/addons_path/module", scan_data=False)
+
+# Disable all
+odoo = OdooParser("/path/to/odoo/odoo", code_stats=False, scan_models=False, scan_data=False)
 ```
+
+## License
+
+This project is licensed under the LGPL-3.0 License - see the [LICENSE](LICENSE) file for details.

odoo_addons_parser-0.7/README.md

@@ -0,0 +1,112 @@
+# odoo-addons-parser
+
+[![Version](https://img.shields.io/pypi/v/odoo-addons-parser.svg?maxAge=86400)](https://pypi.org/project/odoo-addons-parser)
+[![Supported Versions](https://img.shields.io/pypi/pyversions/odoo-addons-parser.svg)](https://pypi.org/project/odoo-addons-parser)
+[![Pre-commit Status](https://github.com/sebalix/odoo-addons-parser/actions/workflows/pre-commit.yml/badge.svg?branch=main)](https://github.com/sebalix/odoo-addons-parser/actions/workflows/pre-commit.yml?query=branch%3Amain)
+[![Tests Status](https://github.com/sebalix/odoo-addons-parser/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sebalix/odoo-addons-parser/actions/workflows/test.yml?query=branch%3Amain)
+
+Python package to collect and analyze data from Odoo module folders without requiring an Odoo runtime. It performs static file analysis to extract useful information from Odoo modules.
+
+## Features
+
+- **Static Analysis**: Doesn't rely on any Odoo runtime; performs static files analysis
+- **Code Statistics**: Count lines of code (Python, XML, JavaScript, and CSS)
+- **Manifest Parsing**: Extract useful data from manifest files (authors, dependencies, etc.)
+- **Model Extraction**: Extract Odoo models information (with fields and methods)
+- **Data Extraction**: Extract data from XML and CSV files
+- **Flexible Scanning**: Scan individual modules, repositories, or entire Odoo source code
+
+## Installation
+
+```bash
+uv pip install odoo-addons-parser
+```
+
+Or with pip:
+```bash
+pip install odoo-addons-parser
+```
+
+## Usage
+
+### ModuleParser
+
+Parse a single Odoo module:
+
+```python
+from odoo_addons_parser import ModuleParser
+from pprint import pprint as pp
+
+mod = ModuleParser("/path/to/OCA/server-tools/server_environment")
+pp(mod.to_dict())
+```
+
+Example output:
+
+```python
+{
+    'code': {'CSS': 0, 'JavaScript': 0, 'Python': 541, 'XML': 21},
+    'manifest': {
+        'author': 'Camptocamp,Odoo Community Association (OCA)',
+        'category': 'Tools',
+        'data': ['security/ir.model.access.csv', 'security/res_groups.xml', 'serv_config.xml'],
+        'depends': ['base', 'base_sparse_field'],
+        'installable': True,
+        'license': 'GPL-3 or any later version',
+        'name': 'server configuration environment files',
+        'summary': 'move some configurations out of the database',
+        'version': '14.0.1.0.0',
+        'website': 'https://github.com/OCA/server-env'
+    },
+    'models': ...,
+    'name': 'server_environment'
+}
+```
+
+### RepositoryParser
+
+Parse a whole repository of addons:
+
+```python
+from odoo_addons_parser import RepositoryParser
+
+repo = RepositoryParser("/path/to/OCA/server-tools")
+pp(repo.to_dict())
+```
+
+### OdooParser
+
+Parse the Odoo source code repository:
+
+```python
+from odoo_addons_parser import OdooParser
+
+odoo = OdooParser("/path/to/odoo/odoo")
+data = odoo.to_dict()
+list(data["__odoo__"]["models"])
+# ["BaseModel", "Model", "TransientModel"]
+"res.partner" in data["base"]["models"]
+# True
+```
+
+## Parameters
+
+You can disable specific features using parameters:
+
+```python
+# Disable code statistics
+repo = RepositoryParser("path/to/addons_path", code_stats=False)
+
+# Disable model scanning
+mod = ModuleParser("path/to/addons_path/module", scan_models=False)
+
+# Disable data scanning
+mod = ModuleParser("path/to/addons_path/module", scan_data=False)
+
+# Disable all
+odoo = OdooParser("/path/to/odoo/odoo", code_stats=False, scan_models=False, scan_data=False)
+```
+
+## License
+
+This project is licensed under the LGPL-3.0 License - see the [LICENSE](LICENSE) file for details.