odoo-easy 0.1.0__tar.gz

odoo_easy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Antonio Maminiaina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

odoo_easy-0.1.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: odoo-easy
+Version: 0.1.0
+Summary: Lightweight Python wrapper for the Odoo XML-RPC API
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/atovoman/odoo-easy
+Project-URL: Repository, https://github.com/atovoman/odoo-easy
+Project-URL: Issues, https://github.com/atovoman/odoo-easy/issues
+Keywords: odoo,xmlrpc,erp,api,wrapper
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# odoo-easy
+
+A lightweight Python wrapper for the Odoo XML-RPC API. Stop writing boilerplate — connect and query Odoo in 3 lines.
+
+## Installation
+
+```bash
+pip install odoo-easy
+```
+
+## Quick Start
+
+```python
+from odoo_connect import OdooClient
+
+odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+odoo.login("admin@example.com", "your-password")
+
+# List products
+products = odoo.search_read("product.template", fields=["name", "list_price"])
+```
+
+## Usage
+
+### Connect
+
+```python
+from odoo_connect import OdooClient
+
+odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+odoo.login("admin@example.com", "your-password")
+```
+
+### Search records
+
+```python
+# Get all IDs
+ids = odoo.search("product.template")
+
+# With filters
+ids = odoo.search("product.template", filters=[["type", "=", "product"]])
+
+# With limit
+ids = odoo.search("product.template", limit=10)
+```
+
+### Search and read in one call
+
+```python
+products = odoo.search_read(
+    "product.template",
+    filters=[["sale_ok", "=", True]],
+    fields=["name", "list_price", "categ_id"],
+    limit=50
+)
+# Returns: [{"id": 1, "name": "My Product", "list_price": 99.0, ...}, ...]
+```
+
+### Read by IDs
+
+```python
+records = odoo.read("res.partner", ids=[1, 2, 3], fields=["name", "email"])
+```
+
+### Create a record
+
+```python
+new_id = odoo.create("product.template", {
+    "name": "New Product",
+    "list_price": 49.99,
+    "type": "product",
+})
+print(f"Created product with ID: {new_id}")
+```
+
+### Update records
+
+```python
+odoo.write("product.template", ids=[1, 2, 3], values={
+    "list_price": 59.99
+})
+```
+
+### Delete records
+
+```python
+odoo.unlink("product.template", ids=[99])
+```
+
+### Count records
+
+```python
+total = odoo.count("product.template", filters=[["active", "=", True]])
+print(f"Total active products: {total}")
+```
+
+### Inspect model fields
+
+```python
+fields = odoo.get_fields("product.template", attributes=["string", "type"])
+```
+
+### Get server version
+
+```python
+info = odoo.version()
+print(info)  # {'server_version': '18.0', ...}
+```
+
+## Error Handling
+
+```python
+from odoo_connect import OdooClient, OdooAuthError, OdooError
+
+try:
+    odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+    odoo.login("wrong@example.com", "badpassword")
+except OdooAuthError as e:
+    print(f"Authentication failed: {e}")
+except OdooError as e:
+    print(f"Odoo error: {e}")
+```
+
+## Compatibility
+
+- Python 3.8+
+- Odoo 14, 15, 16, 17, 18
+
+## License
+
+MIT

odoo_easy-0.1.0/README.md

@@ -0,0 +1,131 @@
+# odoo-easy
+
+A lightweight Python wrapper for the Odoo XML-RPC API. Stop writing boilerplate — connect and query Odoo in 3 lines.
+
+## Installation
+
+```bash
+pip install odoo-easy
+```
+
+## Quick Start
+
+```python
+from odoo_connect import OdooClient
+
+odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+odoo.login("admin@example.com", "your-password")
+
+# List products
+products = odoo.search_read("product.template", fields=["name", "list_price"])
+```
+
+## Usage
+
+### Connect
+
+```python
+from odoo_connect import OdooClient
+
+odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+odoo.login("admin@example.com", "your-password")
+```
+
+### Search records
+
+```python
+# Get all IDs
+ids = odoo.search("product.template")
+
+# With filters
+ids = odoo.search("product.template", filters=[["type", "=", "product"]])
+
+# With limit
+ids = odoo.search("product.template", limit=10)
+```
+
+### Search and read in one call
+
+```python
+products = odoo.search_read(
+    "product.template",
+    filters=[["sale_ok", "=", True]],
+    fields=["name", "list_price", "categ_id"],
+    limit=50
+)
+# Returns: [{"id": 1, "name": "My Product", "list_price": 99.0, ...}, ...]
+```
+
+### Read by IDs
+
+```python
+records = odoo.read("res.partner", ids=[1, 2, 3], fields=["name", "email"])
+```
+
+### Create a record
+
+```python
+new_id = odoo.create("product.template", {
+    "name": "New Product",
+    "list_price": 49.99,
+    "type": "product",
+})
+print(f"Created product with ID: {new_id}")
+```
+
+### Update records
+
+```python
+odoo.write("product.template", ids=[1, 2, 3], values={
+    "list_price": 59.99
+})
+```
+
+### Delete records
+
+```python
+odoo.unlink("product.template", ids=[99])
+```
+
+### Count records
+
+```python
+total = odoo.count("product.template", filters=[["active", "=", True]])
+print(f"Total active products: {total}")
+```
+
+### Inspect model fields
+
+```python
+fields = odoo.get_fields("product.template", attributes=["string", "type"])
+```
+
+### Get server version
+
+```python
+info = odoo.version()
+print(info)  # {'server_version': '18.0', ...}
+```
+
+## Error Handling
+
+```python
+from odoo_connect import OdooClient, OdooAuthError, OdooError
+
+try:
+    odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+    odoo.login("wrong@example.com", "badpassword")
+except OdooAuthError as e:
+    print(f"Authentication failed: {e}")
+except OdooError as e:
+    print(f"Odoo error: {e}")
+```
+
+## Compatibility
+
+- Python 3.8+
+- Odoo 14, 15, 16, 17, 18
+
+## License
+
+MIT

odoo_easy-0.1.0/odoo_connect/__init__.py

@@ -0,0 +1,5 @@
+from .client import OdooClient
+from .exceptions import OdooAuthError, OdooError, OdooRPCError
+
+__version__ = "0.1.0"
+__all__ = ["OdooClient", "OdooAuthError", "OdooError", "OdooRPCError"]

odoo_easy-0.1.0/odoo_connect/client.py

@@ -0,0 +1,231 @@
+import xmlrpc.client
+from .exceptions import OdooAuthError, OdooRPCError
+
+
+class OdooClient:
+    """
+    A lightweight Python wrapper for the Odoo XML-RPC API.
+
+    Usage:
+        from odoo_connect import OdooClient
+
+        odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+        odoo.login("admin@example.com", "password")
+
+        products = odoo.search_read("product.template", fields=["name", "list_price"])
+    """
+
+    def __init__(self, url: str, db: str):
+        """
+        Initialize the Odoo client.
+
+        Args:
+            url: The base URL of your Odoo instance (e.g. "https://mycompany.odoo.com")
+            db:  The database name
+        """
+        self.url = url.rstrip("/")
+        self.db = db
+        self.uid = None
+        self._password = None
+
+        self._common = xmlrpc.client.ServerProxy(f"{self.url}/xmlrpc/2/common")
+        self._models = xmlrpc.client.ServerProxy(f"{self.url}/xmlrpc/2/object")
+
+    # ------------------------------------------------------------------
+    # Auth
+    # ------------------------------------------------------------------
+
+    def login(self, username: str, password: str) -> int:
+        """
+        Authenticate against the Odoo instance.
+
+        Args:
+            username: Your Odoo login (usually an email)
+            password: Your Odoo password or API key
+
+        Returns:
+            The user ID (uid)
+
+        Raises:
+            OdooAuthError: If authentication fails
+        """
+        try:
+            uid = self._common.authenticate(self.db, username, password, {})
+        except Exception as e:
+            raise OdooRPCError(f"Connection error: {e}") from e
+
+        if not uid:
+            raise OdooAuthError(
+                f"Login failed for user '{username}' on database '{self.db}'. "
+                "Check your credentials."
+            )
+
+        self.uid = uid
+        self._password = password
+        return uid
+
+    # ------------------------------------------------------------------
+    # Internal helper
+    # ------------------------------------------------------------------
+
+    def _execute(self, model: str, method: str, *args, **kwargs):
+        """Low-level execute_kw wrapper."""
+        if not self.uid:
+            raise OdooAuthError("Not logged in. Call login() first.")
+        try:
+            return self._models.execute_kw(
+                self.db, self.uid, self._password,
+                model, method, args, kwargs
+            )
+        except xmlrpc.client.Fault as e:
+            raise OdooRPCError(f"Odoo error on {model}.{method}: {e.faultString}") from e
+
+    # ------------------------------------------------------------------
+    # CRUD operations
+    # ------------------------------------------------------------------
+
+    def search(self, model: str, filters: list = None, limit: int = None, offset: int = 0) -> list:
+        """
+        Search for record IDs matching the given filters.
+
+        Args:
+            model:   Odoo model name (e.g. "product.template")
+            filters: Domain filter list (e.g. [["active", "=", True]])
+            limit:   Max number of results (None = no limit)
+            offset:  Number of records to skip
+
+        Returns:
+            List of matching record IDs
+        """
+        domain = filters or []
+        kwargs = {"offset": offset}
+        if limit is not None:
+            kwargs["limit"] = limit
+        return self._execute(model, "search", domain, **kwargs)
+
+    def search_read(self, model: str, filters: list = None, fields: list = None,
+                    limit: int = None, offset: int = 0) -> list:
+        """
+        Search and return records with their field values.
+
+        Args:
+            model:   Odoo model name
+            filters: Domain filter list
+            fields:  List of field names to return (None = all fields)
+            limit:   Max number of results
+            offset:  Number of records to skip
+
+        Returns:
+            List of dicts with the requested field values
+        """
+        domain = filters or []
+        kwargs = {"offset": offset}
+        if fields:
+            kwargs["fields"] = fields
+        if limit is not None:
+            kwargs["limit"] = limit
+        return self._execute(model, "search_read", domain, **kwargs)
+
+    def read(self, model: str, ids: list, fields: list = None) -> list:
+        """
+        Read specific records by their IDs.
+
+        Args:
+            model:  Odoo model name
+            ids:    List of record IDs to read
+            fields: List of field names to return (None = all fields)
+
+        Returns:
+            List of dicts with the requested field values
+        """
+        kwargs = {}
+        if fields:
+            kwargs["fields"] = fields
+        return self._execute(model, "read", ids, **kwargs)
+
+    def create(self, model: str, values: dict) -> int:
+        """
+        Create a new record.
+
+        Args:
+            model:  Odoo model name
+            values: Dict of field values for the new record
+
+        Returns:
+            ID of the newly created record
+        """
+        return self._execute(model, "create", values)
+
+    def write(self, model: str, ids: list, values: dict) -> bool:
+        """
+        Update existing records.
+
+        Args:
+            model:  Odoo model name
+            ids:    List of record IDs to update
+            values: Dict of field values to update
+
+        Returns:
+            True if successful
+        """
+        return self._execute(model, "write", ids, values)
+
+    def unlink(self, model: str, ids: list) -> bool:
+        """
+        Delete records.
+
+        Args:
+            model: Odoo model name
+            ids:   List of record IDs to delete
+
+        Returns:
+            True if successful
+        """
+        return self._execute(model, "unlink", ids)
+
+    def count(self, model: str, filters: list = None) -> int:
+        """
+        Count records matching the given filters.
+
+        Args:
+            model:   Odoo model name
+            filters: Domain filter list
+
+        Returns:
+            Number of matching records
+        """
+        domain = filters or []
+        return self._execute(model, "search_count", domain)
+
+    # ------------------------------------------------------------------
+    # Extras
+    # ------------------------------------------------------------------
+
+    def get_fields(self, model: str, attributes: list = None) -> dict:
+        """
+        Get the field definitions for a model.
+
+        Args:
+            model:      Odoo model name
+            attributes: List of attributes to return (e.g. ["string", "type"])
+
+        Returns:
+            Dict of field definitions
+        """
+        kwargs = {}
+        if attributes:
+            kwargs["attributes"] = attributes
+        return self._execute(model, "fields_get", [], **kwargs)
+
+    def version(self) -> dict:
+        """
+        Get the Odoo server version info.
+
+        Returns:
+            Dict with version information
+        """
+        return self._common.version()
+
+    def __repr__(self):
+        status = f"uid={self.uid}" if self.uid else "not logged in"
+        return f"OdooClient(url='{self.url}', db='{self.db}', {status})"

odoo_easy-0.1.0/odoo_connect/exceptions.py

@@ -0,0 +1,13 @@
+class OdooError(Exception):
+    """Base exception for odoo-connect."""
+    pass
+
+
+class OdooAuthError(OdooError):
+    """Raised when authentication fails."""
+    pass
+
+
+class OdooRPCError(OdooError):
+    """Raised when an XML-RPC call fails."""
+    pass

odoo_easy-0.1.0/odoo_easy.egg-info/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: odoo-easy
+Version: 0.1.0
+Summary: Lightweight Python wrapper for the Odoo XML-RPC API
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/atovoman/odoo-easy
+Project-URL: Repository, https://github.com/atovoman/odoo-easy
+Project-URL: Issues, https://github.com/atovoman/odoo-easy/issues
+Keywords: odoo,xmlrpc,erp,api,wrapper
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# odoo-easy
+
+A lightweight Python wrapper for the Odoo XML-RPC API. Stop writing boilerplate — connect and query Odoo in 3 lines.
+
+## Installation
+
+```bash
+pip install odoo-easy
+```
+
+## Quick Start
+
+```python
+from odoo_connect import OdooClient
+
+odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+odoo.login("admin@example.com", "your-password")
+
+# List products
+products = odoo.search_read("product.template", fields=["name", "list_price"])
+```
+
+## Usage
+
+### Connect
+
+```python
+from odoo_connect import OdooClient
+
+odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+odoo.login("admin@example.com", "your-password")
+```
+
+### Search records
+
+```python
+# Get all IDs
+ids = odoo.search("product.template")
+
+# With filters
+ids = odoo.search("product.template", filters=[["type", "=", "product"]])
+
+# With limit
+ids = odoo.search("product.template", limit=10)
+```
+
+### Search and read in one call
+
+```python
+products = odoo.search_read(
+    "product.template",
+    filters=[["sale_ok", "=", True]],
+    fields=["name", "list_price", "categ_id"],
+    limit=50
+)
+# Returns: [{"id": 1, "name": "My Product", "list_price": 99.0, ...}, ...]
+```
+
+### Read by IDs
+
+```python
+records = odoo.read("res.partner", ids=[1, 2, 3], fields=["name", "email"])
+```
+
+### Create a record
+
+```python
+new_id = odoo.create("product.template", {
+    "name": "New Product",
+    "list_price": 49.99,
+    "type": "product",
+})
+print(f"Created product with ID: {new_id}")
+```
+
+### Update records
+
+```python
+odoo.write("product.template", ids=[1, 2, 3], values={
+    "list_price": 59.99
+})
+```
+
+### Delete records
+
+```python
+odoo.unlink("product.template", ids=[99])
+```
+
+### Count records
+
+```python
+total = odoo.count("product.template", filters=[["active", "=", True]])
+print(f"Total active products: {total}")
+```
+
+### Inspect model fields
+
+```python
+fields = odoo.get_fields("product.template", attributes=["string", "type"])
+```
+
+### Get server version
+
+```python
+info = odoo.version()
+print(info)  # {'server_version': '18.0', ...}
+```
+
+## Error Handling
+
+```python
+from odoo_connect import OdooClient, OdooAuthError, OdooError
+
+try:
+    odoo = OdooClient("https://mycompany.odoo.com", "my-database")
+    odoo.login("wrong@example.com", "badpassword")
+except OdooAuthError as e:
+    print(f"Authentication failed: {e}")
+except OdooError as e:
+    print(f"Odoo error: {e}")
+```
+
+## Compatibility
+
+- Python 3.8+
+- Odoo 14, 15, 16, 17, 18
+
+## License
+
+MIT

odoo_easy-0.1.0/odoo_easy.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+odoo_connect/__init__.py
+odoo_connect/client.py
+odoo_connect/exceptions.py
+odoo_easy.egg-info/PKG-INFO
+odoo_easy.egg-info/SOURCES.txt
+odoo_easy.egg-info/dependency_links.txt
+odoo_easy.egg-info/top_level.txt

odoo_easy-0.1.0/odoo_easy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

odoo_easy-0.1.0/odoo_easy.egg-info/top_level.txt

@@ -0,0 +1 @@
+odoo_connect

odoo_easy-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "odoo-easy"
+version = "0.1.0"
+description = "Lightweight Python wrapper for the Odoo XML-RPC API"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+keywords = ["odoo", "xmlrpc", "erp", "api", "wrapper"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries",
+]
+
+[project.urls]
+Homepage = "https://github.com/atovoman/odoo-easy"
+Repository = "https://github.com/atovoman/odoo-easy"
+Issues = "https://github.com/atovoman/odoo-easy/issues"

odoo_easy-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+