odoo-xmlrpc-wrapper 1.0.1__tar.gz

odoo_xmlrpc_wrapper-1.0.1/LICENSE

@@ -0,0 +1,16 @@
+MIT License
+
+Copyright 2023 Cagatay URESIN
+
+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 NON INFRINGEMENT. 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_xmlrpc_wrapper-1.0.1/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.1
+Name: odoo_xmlrpc_wrapper
+Version: 1.0.1
+Summary: A simple Python library to make CRUD process easier
+Home-page: https://github.com/cagatayuresin/odoo-xmlrpc-wrapper
+Author: Cagatay URESIN
+Author-email: Cagatay URESIN <cagatayuresin@gmail.com>
+Maintainer-email: Cagatay URESIN <cagatayuresin@gmail.com>
+License: MIT License
+        
+        Copyright 2023 Cagatay URESIN
+        
+        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 NON INFRINGEMENT. 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.
+        
+Project-URL: Homepage, https://github.com/cagatayuresin/odoo-xmlrpc-wrapper
+Project-URL: Bug Reports, https://github.com/cagatayuresin/odoo-xmlrpc-wrapper/issues
+Project-URL: Buy Me A Coffee, https://www.buymeacoffee.com/cagatayuresin
+Project-URL: Source, https://github.com/cagatayuresin/odoo-xmlrpc-wrapper
+Keywords: odoo,external,api,xmlrpc,rpc,wrapper
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Odoo
+Classifier: Framework :: Odoo :: 16.0
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: Freeware
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+<a href="https://www.buymeacoffee.com/cagatayuresin" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+# Odoo XMLRPC Wrapper
+***
+A small wrapper for oversimplifying CRUD operations and connecting to the Odoo External API 
+with the Python xmlrpc module.
+***
+## Index
+* [Getting Started](#getting-started)
+  * [Installing via pip](#installing-via-pip)
+  * [A Simple Connection](#a-simple-connection)
+* [CRUD Operations](#crud-operations)
+  * [Create](#create)
+  * [Read](#read)
+  * [Update](#update)
+  * [Delete](#delete)
+* [Miscellaneous](#miscellaneous)
+  * [Search](#search)
+  * [Search and Read](#search-and-read)
+  * [Count](#count)
+  * [Get Fields](#get-fields)
+* [A Little Detail](#a-little-detail)
+  * [Bot Instance](#bot-instance)
+  * [Active Model](#active-model)
+* [Contribution](#contribution)
+* [License](#license)
+***
+## Getting Started
+### Installing via pip
+```bash
+pip install odoo-xmlrpc-wrapper
+```
+### A Simple Connection
+```python
+from odoo_xmlrpc_wrapper import odoo_xmlrpc_wrapper as oxw
+
+
+HOST = "odoo.myhost.com"
+DB = "my_test_db"
+USERLOGIN = "mymailtologin@odoo.com"
+PASSWORD = "mypass"
+
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD)
+```
+Prints:
+```commandline
+Successfully Logged
+Name: Mitchell Admin
+DB: my_test_db
+HOST: https://odoo.myhost.com
+VERSION: saas~16.1
+```
+### CRUD Operations
+Once the model to be processed in the CRUD functions is entered, the following other
+You do not need to specify the model again as long as the model does not change to 
+the operation functions.
+#### Create
+```python
+bot.create("res.partner", {"name": "John Doe"})
+```
+#### Read
+```python
+bot.read(ids=[84], fields=["name"])
+```
+Returns: `[{"id": 84, "name": "John Doe"}]`
+#### Update
+```python
+bot.update(the_id=84, the_obj={"name": "Jane Doe"})
+```
+#### Delete
+```python
+bot.delete(ids=[84])
+```
+### Miscellaneous
+#### Search
+```python
+bot.search(constraints=[("name", "=", "Mitchell Admin")])
+```
+Returns:
+`[2]`
+#### Search and Read
+```python
+bot.search_read(constraints=[("name", "=", "Mitchell Admin")])
+```
+Returns: `[{'id': 2, 'name': 'Mitchell Admin'}]`
+#### Count
+```python
+bot.count()
+```
+Returns: `78`
+#### Get Fields
+```python
+bot.get_fields("res.partner.title", attributes=["type"])
+```
+Output:
+```commandline
+{
+  "name": {"type": "char"},
+  "shortcut": {"type": "char"},
+  "id": {"type": "integer"},
+  "display_name": {"type": "char"},
+  "create_uid": {"type": "many2one"},
+  "create_date": {"type": "datetime"},
+  "write_uid": {"type": "many2one"},
+  "write_date": {"type": "datetime"},
+}
+```
+## A Little Detail
+### Bot Instance
+```python
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD) # Simple Connection
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD, secured=False) # For http:// (no-ssl) (localhost)
+bot = oxw.Bot(test=True) # For XMLRPC Tests from Odoo saas
+```
+If you are going to connect to a host with an unencrypted http protocol such as localhost,
+`secured=False` must be specified.
+
+`test=True` allows you to connect to one of Odoo's own xmlrpc test servers. Odoo assigns 
+you a random host, database, user and password from the demo servers. You don't need other 
+attributes when test option is selected.
+### Active Model
+The default model when a bot instance is initialized is `"res.users"`. So when you command
+`bot.count()` it returns active users total as an integer.
+
+You can assign the active model at any time with `bot.model = "model.name"` or when calling 
+any next method, such as `bot.count("res.partner")`
+
+## Contribution
+Feel free to contribute. This project needs a fine exception handling.
+## License
+[MIT License](https://en.wikipedia.org/wiki/MIT_License)
+
+Copyright 2023 Cagatay URESIN
+
+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 NON INFRINGEMENT. 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_xmlrpc_wrapper-1.0.1/README.md

@@ -0,0 +1,148 @@
+<a href="https://www.buymeacoffee.com/cagatayuresin" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+# Odoo XMLRPC Wrapper
+***
+A small wrapper for oversimplifying CRUD operations and connecting to the Odoo External API 
+with the Python xmlrpc module.
+***
+## Index
+* [Getting Started](#getting-started)
+  * [Installing via pip](#installing-via-pip)
+  * [A Simple Connection](#a-simple-connection)
+* [CRUD Operations](#crud-operations)
+  * [Create](#create)
+  * [Read](#read)
+  * [Update](#update)
+  * [Delete](#delete)
+* [Miscellaneous](#miscellaneous)
+  * [Search](#search)
+  * [Search and Read](#search-and-read)
+  * [Count](#count)
+  * [Get Fields](#get-fields)
+* [A Little Detail](#a-little-detail)
+  * [Bot Instance](#bot-instance)
+  * [Active Model](#active-model)
+* [Contribution](#contribution)
+* [License](#license)
+***
+## Getting Started
+### Installing via pip
+```bash
+pip install odoo-xmlrpc-wrapper
+```
+### A Simple Connection
+```python
+from odoo_xmlrpc_wrapper import odoo_xmlrpc_wrapper as oxw
+
+
+HOST = "odoo.myhost.com"
+DB = "my_test_db"
+USERLOGIN = "mymailtologin@odoo.com"
+PASSWORD = "mypass"
+
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD)
+```
+Prints:
+```commandline
+Successfully Logged
+Name: Mitchell Admin
+DB: my_test_db
+HOST: https://odoo.myhost.com
+VERSION: saas~16.1
+```
+### CRUD Operations
+Once the model to be processed in the CRUD functions is entered, the following other
+You do not need to specify the model again as long as the model does not change to 
+the operation functions.
+#### Create
+```python
+bot.create("res.partner", {"name": "John Doe"})
+```
+#### Read
+```python
+bot.read(ids=[84], fields=["name"])
+```
+Returns: `[{"id": 84, "name": "John Doe"}]`
+#### Update
+```python
+bot.update(the_id=84, the_obj={"name": "Jane Doe"})
+```
+#### Delete
+```python
+bot.delete(ids=[84])
+```
+### Miscellaneous
+#### Search
+```python
+bot.search(constraints=[("name", "=", "Mitchell Admin")])
+```
+Returns:
+`[2]`
+#### Search and Read
+```python
+bot.search_read(constraints=[("name", "=", "Mitchell Admin")])
+```
+Returns: `[{'id': 2, 'name': 'Mitchell Admin'}]`
+#### Count
+```python
+bot.count()
+```
+Returns: `78`
+#### Get Fields
+```python
+bot.get_fields("res.partner.title", attributes=["type"])
+```
+Output:
+```commandline
+{
+  "name": {"type": "char"},
+  "shortcut": {"type": "char"},
+  "id": {"type": "integer"},
+  "display_name": {"type": "char"},
+  "create_uid": {"type": "many2one"},
+  "create_date": {"type": "datetime"},
+  "write_uid": {"type": "many2one"},
+  "write_date": {"type": "datetime"},
+}
+```
+## A Little Detail
+### Bot Instance
+```python
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD) # Simple Connection
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD, secured=False) # For http:// (no-ssl) (localhost)
+bot = oxw.Bot(test=True) # For XMLRPC Tests from Odoo saas
+```
+If you are going to connect to a host with an unencrypted http protocol such as localhost,
+`secured=False` must be specified.
+
+`test=True` allows you to connect to one of Odoo's own xmlrpc test servers. Odoo assigns 
+you a random host, database, user and password from the demo servers. You don't need other 
+attributes when test option is selected.
+### Active Model
+The default model when a bot instance is initialized is `"res.users"`. So when you command
+`bot.count()` it returns active users total as an integer.
+
+You can assign the active model at any time with `bot.model = "model.name"` or when calling 
+any next method, such as `bot.count("res.partner")`
+
+## Contribution
+Feel free to contribute. This project needs a fine exception handling.
+## License
+[MIT License](https://en.wikipedia.org/wiki/MIT_License)
+
+Copyright 2023 Cagatay URESIN
+
+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 NON INFRINGEMENT. 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_xmlrpc_wrapper-1.0.1/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "odoo_xmlrpc_wrapper"
+version = "1.0.1"
+description = "A simple Python library to make CRUD process easier"
+readme = "README.md"
+requires-python = ">=3.7"
+license = {file = "LICENSE"}
+keywords = ["odoo", "external", "api", "xmlrpc", "rpc", "wrapper"]
+authors = [
+  {name = "Cagatay URESIN", email = "cagatayuresin@gmail.com"}
+]
+maintainers = [
+  {name = "Cagatay URESIN", email = "cagatayuresin@gmail.com"}
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Console",
+  "Framework :: Odoo",
+  "Framework :: Odoo :: 16.0",
+  "Intended Audience :: Developers",
+  "Intended Audience :: System Administrators",
+  "License :: Freeware",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.7",
+  "Topic :: Office/Business",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+[project.urls]
+"Homepage" = "https://github.com/cagatayuresin/odoo-xmlrpc-wrapper"
+"Bug Reports" = "https://github.com/cagatayuresin/odoo-xmlrpc-wrapper/issues"
+"Buy Me A Coffee" = "https://www.buymeacoffee.com/cagatayuresin"
+"Source" = "https://github.com/cagatayuresin/odoo-xmlrpc-wrapper"
+[build-system]
+requires = ["setuptools>=43.0.0", "wheel"]
+build-backend = "setuptools.build_meta"

odoo_xmlrpc_wrapper-1.0.1/setup.cfg

@@ -0,0 +1,41 @@
+[metadata]
+name = odoo_xmlrpc_wrapper
+version = 1.0.1
+author = Cagatay URESIN
+author_email = cagatayuresin@gmail.com
+description = A simple Python library to make CRUD process easier
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/cagatayuresin/odoo-xmlrpc-wrapper
+project_urls = 
+	Bug Tracker = https://github.com/cagatayuresin/odoo-xmlrpc-wrapper/-/issues
+	repository = https://github.com/cagatayuresin/odoo-xmlrpc-wrapper
+classifiers = 
+	Development Status :: 5 - Production/Stable
+	Environment :: Console
+	Framework :: Odoo
+	Framework :: Odoo :: 16.0
+	Intended Audience :: Developers
+	Intended Audience :: System Administrators
+	License :: Freeware
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Programming Language :: Python :: 3 :: Only
+	Programming Language :: Python :: 3.7
+	Topic :: Office/Business
+	Topic :: Software Development :: Libraries
+	Topic :: Software Development :: Libraries :: Python Modules
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.7
+
+[options.packages.find]
+where = src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

odoo_xmlrpc_wrapper-1.0.1/setup.py

@@ -0,0 +1,36 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="odoo_xmlrpc_wrapper",
+    version="1.0.1",
+    description="A simple Python library to make CRUD process easier.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/cagatayuresin/odoo-xmlrpc-wrapper",
+    author="Cagatay URESIN",
+    author_email="cagatayuresin@gmail.com",
+    license="MIT",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Environment :: Console",
+        "Framework :: Odoo",
+        "Framework :: Odoo :: 16.0",
+        "Intended Audience :: Developers",
+        "Intended Audience :: System Administrators",
+        "License :: Freeware",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.7",
+        "Topic :: Office/Business",
+        "Topic :: Software Development :: Libraries",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+    ],
+    package_dir={"": "src"},
+    packages=find_packages(where="src"),
+    python_requires=">=3.7",
+    keywords="odoo external api xmlrpc rpc wrapper",
+)

odoo_xmlrpc_wrapper-1.0.1/src/odoo_xmlrpc_wrapper/__init__.py

@@ -0,0 +1,8 @@
+"""
+Odoo XMLRPC Wrapper
+
+A simple Python to make CRUD process easier
+"""
+
+__version__ = "1.0.1"
+__author__ = 'Cagatay URESIN'

odoo_xmlrpc_wrapper-1.0.1/src/odoo_xmlrpc_wrapper/odoo_xmlrpc_wrapper.py

@@ -0,0 +1,264 @@
+import xmlrpc.client
+
+
+class Bot:
+    """
+    A bot class to rule them all.
+    """
+
+    def __init__(
+        self,
+        host: str = None,
+        db: str = None,
+        userlogin: str = None,
+        password: str = None,
+        secured: bool = True,
+        test: bool = False,
+    ) -> None:
+        """
+        Bot instance initializer: If test = True other arguments muted. For http:// secured = False
+
+        Args:
+            host (str, optional): The host 'odoo.yourhost.com'. Defaults to None.
+            db (str, optional): Database to login. Defaults to None.
+            userlogin (str, optional): Login string. Defaults to None.
+            password (str, optional): Password. Defaults to None.
+            secured (bool, optional): http:// or https://. Defaults to True.
+            test (bool, optional): To use Odoo's own test servers. Defaults to False.
+        """
+        self.__test_info = (
+            xmlrpc.client.ServerProxy("https://demo.odoo.com/start").start()
+            if test
+            else "Not Test"
+        )
+        self.HOST = self.__test_info["host"][8:] if test else host
+        self.URL = (
+            f"https://{self.HOST}/xmlrpc/2"
+            if secured
+            else f"http://{self.HOST}/xmlrpc/2"
+        )
+        self.DB = self.__test_info["database"] if test else db
+        self.USERLOGIN = self.__test_info["user"] if test else userlogin
+        self.__PASSWORD = self.__test_info["password"] if test else password
+        self.model = None
+        self.__common = xmlrpc.client.ServerProxy(f"{self.URL}/common")
+        self.version = self.__common.version()
+        self.uid = self.__common.authenticate(
+            self.DB, self.USERLOGIN, self.__PASSWORD, {}
+        )
+        if not self.uid:
+            raise Exception(
+                f"Wrong one ({self.HOST}, {self.DB}, {self.USERLOGIN}, PASSWORD)"
+            )
+        self.__orm = xmlrpc.client.ServerProxy(f"{self.URL}/object")
+        self.profile = self.read("res.users", ids=self.uid, fields=["name"])[0]
+        self.name = self.profile["name"]
+        self.successful = True
+        print(
+            f"Successfully Logged\n"
+            f"Name: {self.name}\n"
+            f"DB: {self.DB}\n"
+            f"HOST: {self.HOST}\n"
+            f"VERSION: {self.version['server_version']}"
+        )
+
+    def search_read(
+        self,
+        model: str = None,
+        constraints: list = None,
+        fields: list = None,
+        limit: int = None,
+    ) -> list:
+        """
+        Searches with constraints amd reads the results fields.
+
+        Args:
+            model (str, optional): Model name. Defaults to None.
+            constraints (list, optional): Search constraints. Defaults to None.
+            fields (list, optional): Desired fields to read. Defaults to ["name"].
+            limit (int, optional): Result limit. Defaults to None.
+
+        Returns:
+            list: A list of results as dicts with desired fields.
+        """
+        if model:
+            self.model = model
+        if fields is None:
+            fields = ["name"]
+        if constraints is None:
+            constraints = [[]]
+        else:
+            constraints = [constraints]
+        return self.__orm.execute_kw(
+            self.DB,
+            self.uid,
+            self.__PASSWORD,
+            self.model,
+            "search_read",
+            constraints,
+            {"fields": fields} if limit is None else {"fields": fields, "limit": limit},
+        )
+
+    def search(
+        self,
+        model: str = None,
+        constraints: list = None,
+        offset: int = None,
+        limit: int = None,
+    ) -> list:
+        """
+        Searches with constraints and returns results ids.
+
+        Args:
+            model (str, optional): Model name. Defaults to None.
+            constraints (list, optional): Search constraints. Defaults to None.
+            offset (int, optional): Offset. Defaults to None.
+            limit (int, optional): Result limit. Defaults to None.
+
+        Returns:
+            list: A list of record ids as integers.
+        """
+        if model:
+            self.model = model
+        if constraints is None:
+            constraints = [[]]
+        else:
+            constraints = [constraints]
+        return self.__orm.execute_kw(
+            self.DB,
+            self.uid,
+            self.__PASSWORD,
+            self.model,
+            "search",
+            constraints,
+            {"offset": offset, "limit": limit}
+            if offset and limit
+            else {"offset": offset}
+            if offset
+            else {"limit": limit}
+            if limit
+            else {},
+        )
+
+    def count(self, model: str = None, constraints: list = None) -> int:
+        """
+        Length of records with constraints.
+
+        Args:
+            model (str, optional): Model name. Defaults to None.
+            constraints (list, optional): Search constraints. Defaults to None.
+
+        Returns:
+            int: Count of records.
+        """
+        return len(self.search(model, constraints))
+
+    def read(self, model: str = None, ids: list = None, fields: list = None) -> list:
+        """
+        Reads ids with desired fields.
+
+        Args:
+            model (str, optional): Model name. Defaults to None.
+            ids (list, optional): List of ids to read. Defaults to None.
+            fields (list, optional): Desired fields to read. Defaults to None.
+
+        Returns:
+            list: A list of results as dicts with desired fields.
+        """
+        if model:
+            self.model = model
+        return self.__orm.execute_kw(
+            self.DB,
+            self.uid,
+            self.__PASSWORD,
+            self.model,
+            "read",
+            [ids],
+            {"fields": fields} if fields else {},
+        )
+
+    def delete(self, model: str = None, ids: list = None) -> None:
+        """
+        ID list to delete.
+
+        Args:
+            model (str, optional): Model name. Defaults to None.
+            ids (list, optional): List of ids to delete. Defaults to None.
+        """
+        if model:
+            self.model = model
+        self.__orm.execute_kw(
+            self.DB,
+            self.uid,
+            self.__PASSWORD,
+            self.model,
+            "unlink",
+            [ids] if isinstance(ids, list) else [[ids]],
+        )
+
+    def create(self, model: str = None, the_obj: dict = None) -> None:
+        """
+        Creates new record.
+
+        Args:
+            model (str, optional): Model name. Defaults to None.
+            the_obj (dict, optional): The object as dict to create. Defaults to None.
+
+        Raises:
+            ValueError: No Object
+        """
+        if the_obj is None:
+            raise ValueError("No Object")
+        if model:
+            self.model = model
+        self.__orm.execute_kw(
+            self.DB, self.uid, self.__PASSWORD, self.model, "create", [the_obj]
+        )
+
+    def update(
+        self, model: str = None, the_id: int = None, the_obj: dict = None
+    ) -> None:
+        """
+        Updates a record.
+
+        Args:
+            model (str, optional): Model name. Defaults to None.
+            the_id (int, optional): The id as integer of the record. Defaults to None.
+            the_obj (dict, optional): The object as dict to update. Defaults to None.
+
+        Raises:
+            ValueError: No ID
+            ValueError: No Object
+        """
+        if id is None:
+            raise ValueError("No ID")
+        if the_obj is None:
+            raise ValueError("No Object")
+        if model:
+            self.model = model
+        self.__orm.execute_kw(
+            self.DB, self.uid, self.__PASSWORD, self.model, "write", [[the_id], the_obj]
+        )
+
+    def get_fields(self, model: str = None, attributes: list = None) -> dict:
+        """
+        Model fields with desired infos.
+
+        Args:
+            model (str, optional): Model name. Defaults to None.
+            attributes (list, optional): Desired attributes of the fields. Defaults to None.
+
+        Returns:
+            dict: Fields of the model.
+        """
+        if model:
+            self.model = model
+        return self.__orm.execute_kw(
+            self.DB,
+            self.uid,
+            self.__PASSWORD,
+            self.model,
+            "fields_get",
+            [],
+            {"attributes": attributes} if attributes else {},
+        )

odoo_xmlrpc_wrapper-1.0.1/src/odoo_xmlrpc_wrapper.egg-info/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.1
+Name: odoo-xmlrpc-wrapper
+Version: 1.0.1
+Summary: A simple Python library to make CRUD process easier
+Home-page: https://github.com/cagatayuresin/odoo-xmlrpc-wrapper
+Author: Cagatay URESIN
+Author-email: Cagatay URESIN <cagatayuresin@gmail.com>
+Maintainer-email: Cagatay URESIN <cagatayuresin@gmail.com>
+License: MIT License
+        
+        Copyright 2023 Cagatay URESIN
+        
+        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 NON INFRINGEMENT. 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.
+        
+Project-URL: Homepage, https://github.com/cagatayuresin/odoo-xmlrpc-wrapper
+Project-URL: Bug Reports, https://github.com/cagatayuresin/odoo-xmlrpc-wrapper/issues
+Project-URL: Buy Me A Coffee, https://www.buymeacoffee.com/cagatayuresin
+Project-URL: Source, https://github.com/cagatayuresin/odoo-xmlrpc-wrapper
+Keywords: odoo,external,api,xmlrpc,rpc,wrapper
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Odoo
+Classifier: Framework :: Odoo :: 16.0
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: Freeware
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+<a href="https://www.buymeacoffee.com/cagatayuresin" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+# Odoo XMLRPC Wrapper
+***
+A small wrapper for oversimplifying CRUD operations and connecting to the Odoo External API 
+with the Python xmlrpc module.
+***
+## Index
+* [Getting Started](#getting-started)
+  * [Installing via pip](#installing-via-pip)
+  * [A Simple Connection](#a-simple-connection)
+* [CRUD Operations](#crud-operations)
+  * [Create](#create)
+  * [Read](#read)
+  * [Update](#update)
+  * [Delete](#delete)
+* [Miscellaneous](#miscellaneous)
+  * [Search](#search)
+  * [Search and Read](#search-and-read)
+  * [Count](#count)
+  * [Get Fields](#get-fields)
+* [A Little Detail](#a-little-detail)
+  * [Bot Instance](#bot-instance)
+  * [Active Model](#active-model)
+* [Contribution](#contribution)
+* [License](#license)
+***
+## Getting Started
+### Installing via pip
+```bash
+pip install odoo-xmlrpc-wrapper
+```
+### A Simple Connection
+```python
+from odoo_xmlrpc_wrapper import odoo_xmlrpc_wrapper as oxw
+
+
+HOST = "odoo.myhost.com"
+DB = "my_test_db"
+USERLOGIN = "mymailtologin@odoo.com"
+PASSWORD = "mypass"
+
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD)
+```
+Prints:
+```commandline
+Successfully Logged
+Name: Mitchell Admin
+DB: my_test_db
+HOST: https://odoo.myhost.com
+VERSION: saas~16.1
+```
+### CRUD Operations
+Once the model to be processed in the CRUD functions is entered, the following other
+You do not need to specify the model again as long as the model does not change to 
+the operation functions.
+#### Create
+```python
+bot.create("res.partner", {"name": "John Doe"})
+```
+#### Read
+```python
+bot.read(ids=[84], fields=["name"])
+```
+Returns: `[{"id": 84, "name": "John Doe"}]`
+#### Update
+```python
+bot.update(the_id=84, the_obj={"name": "Jane Doe"})
+```
+#### Delete
+```python
+bot.delete(ids=[84])
+```
+### Miscellaneous
+#### Search
+```python
+bot.search(constraints=[("name", "=", "Mitchell Admin")])
+```
+Returns:
+`[2]`
+#### Search and Read
+```python
+bot.search_read(constraints=[("name", "=", "Mitchell Admin")])
+```
+Returns: `[{'id': 2, 'name': 'Mitchell Admin'}]`
+#### Count
+```python
+bot.count()
+```
+Returns: `78`
+#### Get Fields
+```python
+bot.get_fields("res.partner.title", attributes=["type"])
+```
+Output:
+```commandline
+{
+  "name": {"type": "char"},
+  "shortcut": {"type": "char"},
+  "id": {"type": "integer"},
+  "display_name": {"type": "char"},
+  "create_uid": {"type": "many2one"},
+  "create_date": {"type": "datetime"},
+  "write_uid": {"type": "many2one"},
+  "write_date": {"type": "datetime"},
+}
+```
+## A Little Detail
+### Bot Instance
+```python
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD) # Simple Connection
+bot = oxw.Bot(HOST, DB, USERLOGIN, PASSWORD, secured=False) # For http:// (no-ssl) (localhost)
+bot = oxw.Bot(test=True) # For XMLRPC Tests from Odoo saas
+```
+If you are going to connect to a host with an unencrypted http protocol such as localhost,
+`secured=False` must be specified.
+
+`test=True` allows you to connect to one of Odoo's own xmlrpc test servers. Odoo assigns 
+you a random host, database, user and password from the demo servers. You don't need other 
+attributes when test option is selected.
+### Active Model
+The default model when a bot instance is initialized is `"res.users"`. So when you command
+`bot.count()` it returns active users total as an integer.
+
+You can assign the active model at any time with `bot.model = "model.name"` or when calling 
+any next method, such as `bot.count("res.partner")`
+
+## Contribution
+Feel free to contribute. This project needs a fine exception handling.
+## License
+[MIT License](https://en.wikipedia.org/wiki/MIT_License)
+
+Copyright 2023 Cagatay URESIN
+
+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 NON INFRINGEMENT. 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_xmlrpc_wrapper-1.0.1/src/odoo_xmlrpc_wrapper.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+src/odoo_xmlrpc_wrapper/__init__.py
+src/odoo_xmlrpc_wrapper/odoo_xmlrpc_wrapper.py
+src/odoo_xmlrpc_wrapper.egg-info/PKG-INFO
+src/odoo_xmlrpc_wrapper.egg-info/SOURCES.txt
+src/odoo_xmlrpc_wrapper.egg-info/dependency_links.txt
+src/odoo_xmlrpc_wrapper.egg-info/top_level.txt
+tests/test_odoo_xmlrpc_wapper.py

odoo_xmlrpc_wrapper-1.0.1/src/odoo_xmlrpc_wrapper.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

odoo_xmlrpc_wrapper-1.0.1/src/odoo_xmlrpc_wrapper.egg-info/top_level.txt

@@ -0,0 +1 @@
+odoo_xmlrpc_wrapper

odoo_xmlrpc_wrapper-1.0.1/tests/test_odoo_xmlrpc_wapper.py

@@ -0,0 +1,48 @@
+import unittest
+from src.odoo_xmlrpc_wrapper import odoo_xmlrpc_wrapper as oxw
+
+
+class TestOXW(unittest.TestCase):
+    bot = oxw.Bot(test=True)
+
+    def test_case_0(self):
+        self.assertEqual(self.bot.successful, True)
+
+    def test_case_1(self):
+        self.bot.create("res.partner", {"name": "John Doe"})
+        self.assertEqual(
+            self.bot.search_read(constraints=[("name", "=", "John Doe")]),
+            [{"id": 84, "name": "John Doe"}],
+        )
+        self.assertEqual(
+            self.bot.search(constraints=[("name", "=", "John Doe")]),
+            [84],
+        )
+
+    def test_case_2(self):
+        self.bot.update(the_id=84, the_obj={"name": "Jane Doe"})
+        self.assertEqual(
+            self.bot.read(ids=[84], fields=["name"]), [{"id": 84, "name": "Jane Doe"}]
+        )
+
+    def test_case_3(self):
+        self.assertEqual(self.bot.count(), 79)
+
+    def test_case_4(self):
+        self.assertDictEqual(
+            self.bot.get_fields("res.partner.title", attributes=["type"]),
+            {
+                "name": {"type": "char"},
+                "shortcut": {"type": "char"},
+                "id": {"type": "integer"},
+                "display_name": {"type": "char"},
+                "create_uid": {"type": "many2one"},
+                "create_date": {"type": "datetime"},
+                "write_uid": {"type": "many2one"},
+                "write_date": {"type": "datetime"},
+            },
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()