| Name | pyodoo-connect JSON |
| Version |
0.1.6
JSON |
| download |
| home_page | https://github.com/fasilwdr/pyodoo_connector |
| Summary | A Python package to interact with Odoo via JSON-RPC. |
| upload_time | 2024-12-08 12:25:51 |
| maintainer | None |
| docs_url | None |
| author | Fasil |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) [2024] [Fasil] 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. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
httpx
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyOdoo Connector
A powerful Python package for interacting with Odoo platforms via JSON-RPC. This library provides a seamless interface for performing CRUD operations, managing sessions, and executing custom methods on your Odoo instance.
## Features
- 🔐 Secure session management and authentication
- 📝 Complete CRUD operations support
- 🔄 Automatic session renewal
- 🎯 Custom method execution
- 🛡️ Comprehensive error handling
- 🔍 Smart record browsing and caching
- 📊 Efficient batch operations
- 🌐 Context management
- 🔑 Session ID based authentication (New in 0.1.6)
## Installation
```bash
pip install pyodoo_connect --upgrade
```
### Requirements
- Python 3.6+
- httpx>=0.24.0
- Access to an Odoo instance with JSON-RPC enabled
## Quick Start
### Basic Connection
You can connect to Odoo in two ways:
#### 1. Using Credentials (Traditional)
```python
from pyodoo_connect import connect_odoo
# Connect using credentials
odoo, session_id = connect_odoo(
url="https://your-odoo-instance.com",
db="your_database",
username="your_username",
password="your_password"
)
```
#### 2. Using Session ID (New in 0.1.6)
```python
from pyodoo_connect import connect_odoo
# Connect using existing session ID
odoo, session_id = connect_odoo(
url="https://your-odoo-instance.com",
session_id="your_session_id"
)
```
## Usage Examples
### 1. Record Operations
#### Create Records
```python
# Create a single partner
partner_id = odoo.env('res.partner').create({
'name': 'John Doe',
'email': 'john@example.com',
'phone': '+1234567890',
'is_company': True
})
# Create with related records
from pyodoo_connect import Command
sales_order = odoo.env('sale.order').create({
'partner_id': partner_id,
'order_line': [Command.create({
'product_id': 1,
'product_uom_qty': 2,
'price_unit': 100
})]
})
```
#### Read Records
```python
# Browse a single record
partner = odoo.env('res.partner').browse(partner_id)
print(f"Partner Name: {partner.name}")
print(f"Email: {partner.email}")
# Search and read multiple records
partners = odoo.env('res.partner').search_read(
domain=[('is_company', '=', True)],
fields=['name', 'email', 'phone'],
limit=5
)
for partner in partners:
print(f"Company: {partner['name']}")
```
#### Update Records
```python
# Update using write method
odoo.env('res.partner').write([partner_id], {
'name': 'John Smith',
'email': 'john.smith@example.com'
})
# Update using record attribute
partner = odoo.env('res.partner').browse(partner_id)
partner.phone = '+9876543210'
```
#### Delete Records
```python
# Delete a single record
odoo.env('res.partner').unlink([partner_id])
# Delete multiple records
partner_ids = odoo.env('res.partner').search([
('name', 'like', 'Test%')
])
odoo.env('res.partner').unlink(partner_ids)
```
### 2. Relational Fields Operations
Using Command class for managing relations:
```python
from pyodoo_connect import Command
# Link existing records
partner.category_id = [Command.set([1, 2, 3])] # Set specific tags
# Create and link new record
partner.child_ids = [
Command.create({
'name': 'Contact Person',
'email': 'contact@example.com'
})
]
# Update linked record
partner.child_ids = [
Command.update(child_id, {
'name': 'New Name'
})
]
# Unlink records
partner.category_id = [Command.unlink(tag_id)]
# Clear all relations
partner.category_id = [Command.clear()]
```
### 3. Search Operations
```python
# Basic search
customer_ids = odoo.env('res.partner').search([
('customer_rank', '>', 0),
('is_company', '=', True)
])
# Search with additional parameters
products = odoo.env('product.product').search_read(
domain=[('type', '=', 'product')],
fields=['name', 'list_price', 'qty_available'],
offset=0,
limit=10,
order='name ASC'
)
```
### 4. Context Management
```python
# Set context for specific operations
order = odoo.env('sale.order').browse(order_id)
order.with_context(force_company=2).action_confirm()
# Multiple context values
result = order.with_context({
'lang': 'es_ES',
'tz': 'Europe/Madrid',
'force_company': 2
}).action_invoice_create()
```
### 5. Custom Method Execution
```python
# Execute custom methods on records
sale_order = odoo.env('sale.order').browse(order_id)
sale_order.action_confirm() # Confirm sale order
# Execute with parameters
invoice = sale_order.with_context(default_type='out_invoice')._create_invoices()
```
### 6. Error Handling
The library provides specific exceptions for different error scenarios:
```python
from pyodoo_connect import (
OdooException,
OdooConnectionError,
OdooAuthenticationError,
OdooRequestError,
OdooValidationError
)
try:
odoo.env('res.partner').create({
'name': 'Test',
'email': 'invalid_email' # This will raise a validation error
})
except OdooValidationError as e:
print(f"Validation Error: {str(e)}")
except OdooConnectionError as e:
print(f"Connection Error: {str(e)}")
except OdooException as e:
print(f"General Odoo Error: {str(e)}")
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Author
- **Name:** Fasil
- **Email:** fasilwdr@hotmail.com
- **WhatsApp:** [Contact](https://wa.me/966538952934)
Raw data
{
"_id": null,
"home_page": "https://github.com/fasilwdr/pyodoo_connector",
"name": "pyodoo-connect",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Fasil",
"author_email": "Fasil <fasilwdr@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/06/e9/0cd2ab66ca98f5424862944747f9965f42bfa947553ffb41be1ffabd3170/pyodoo_connect-0.1.6.tar.gz",
"platform": null,
"description": "# PyOdoo Connector\n\nA powerful Python package for interacting with Odoo platforms via JSON-RPC. This library provides a seamless interface for performing CRUD operations, managing sessions, and executing custom methods on your Odoo instance.\n\n## Features\n\n- \ud83d\udd10 Secure session management and authentication\n- \ud83d\udcdd Complete CRUD operations support\n- \ud83d\udd04 Automatic session renewal\n- \ud83c\udfaf Custom method execution\n- \ud83d\udee1\ufe0f Comprehensive error handling\n- \ud83d\udd0d Smart record browsing and caching\n- \ud83d\udcca Efficient batch operations\n- \ud83c\udf10 Context management\n- \ud83d\udd11 Session ID based authentication (New in 0.1.6)\n\n## Installation\n\n```bash\npip install pyodoo_connect --upgrade\n```\n\n### Requirements\n- Python 3.6+\n- httpx>=0.24.0\n- Access to an Odoo instance with JSON-RPC enabled\n\n## Quick Start\n\n### Basic Connection\n\nYou can connect to Odoo in two ways:\n\n#### 1. Using Credentials (Traditional)\n```python\nfrom pyodoo_connect import connect_odoo\n\n# Connect using credentials\nodoo, session_id = connect_odoo(\n url=\"https://your-odoo-instance.com\",\n db=\"your_database\",\n username=\"your_username\",\n password=\"your_password\"\n)\n```\n\n#### 2. Using Session ID (New in 0.1.6)\n```python\nfrom pyodoo_connect import connect_odoo\n\n# Connect using existing session ID\nodoo, session_id = connect_odoo(\n url=\"https://your-odoo-instance.com\",\n session_id=\"your_session_id\"\n)\n```\n\n## Usage Examples\n\n### 1. Record Operations\n\n#### Create Records\n```python\n# Create a single partner\npartner_id = odoo.env('res.partner').create({\n 'name': 'John Doe',\n 'email': 'john@example.com',\n 'phone': '+1234567890',\n 'is_company': True\n})\n\n# Create with related records\nfrom pyodoo_connect import Command\n\nsales_order = odoo.env('sale.order').create({\n 'partner_id': partner_id,\n 'order_line': [Command.create({\n 'product_id': 1,\n 'product_uom_qty': 2,\n 'price_unit': 100\n })]\n})\n```\n\n#### Read Records\n```python\n# Browse a single record\npartner = odoo.env('res.partner').browse(partner_id)\nprint(f\"Partner Name: {partner.name}\")\nprint(f\"Email: {partner.email}\")\n\n# Search and read multiple records\npartners = odoo.env('res.partner').search_read(\n domain=[('is_company', '=', True)],\n fields=['name', 'email', 'phone'],\n limit=5\n)\nfor partner in partners:\n print(f\"Company: {partner['name']}\")\n```\n\n#### Update Records\n```python\n# Update using write method\nodoo.env('res.partner').write([partner_id], {\n 'name': 'John Smith',\n 'email': 'john.smith@example.com'\n})\n\n# Update using record attribute\npartner = odoo.env('res.partner').browse(partner_id)\npartner.phone = '+9876543210'\n```\n\n#### Delete Records\n```python\n# Delete a single record\nodoo.env('res.partner').unlink([partner_id])\n\n# Delete multiple records\npartner_ids = odoo.env('res.partner').search([\n ('name', 'like', 'Test%')\n])\nodoo.env('res.partner').unlink(partner_ids)\n```\n\n### 2. Relational Fields Operations\n\nUsing Command class for managing relations:\n\n```python\nfrom pyodoo_connect import Command\n\n# Link existing records\npartner.category_id = [Command.set([1, 2, 3])] # Set specific tags\n\n# Create and link new record\npartner.child_ids = [\n Command.create({\n 'name': 'Contact Person',\n 'email': 'contact@example.com'\n })\n]\n\n# Update linked record\npartner.child_ids = [\n Command.update(child_id, {\n 'name': 'New Name'\n })\n]\n\n# Unlink records\npartner.category_id = [Command.unlink(tag_id)]\n\n# Clear all relations\npartner.category_id = [Command.clear()]\n```\n\n### 3. Search Operations\n\n```python\n# Basic search\ncustomer_ids = odoo.env('res.partner').search([\n ('customer_rank', '>', 0),\n ('is_company', '=', True)\n])\n\n# Search with additional parameters\nproducts = odoo.env('product.product').search_read(\n domain=[('type', '=', 'product')],\n fields=['name', 'list_price', 'qty_available'],\n offset=0,\n limit=10,\n order='name ASC'\n)\n```\n\n### 4. Context Management\n\n```python\n# Set context for specific operations\norder = odoo.env('sale.order').browse(order_id)\norder.with_context(force_company=2).action_confirm()\n\n# Multiple context values\nresult = order.with_context({\n 'lang': 'es_ES',\n 'tz': 'Europe/Madrid',\n 'force_company': 2\n}).action_invoice_create()\n```\n\n### 5. Custom Method Execution\n\n```python\n# Execute custom methods on records\nsale_order = odoo.env('sale.order').browse(order_id)\nsale_order.action_confirm() # Confirm sale order\n\n# Execute with parameters\ninvoice = sale_order.with_context(default_type='out_invoice')._create_invoices()\n```\n\n### 6. Error Handling\n\nThe library provides specific exceptions for different error scenarios:\n\n```python\nfrom pyodoo_connect import (\n OdooException,\n OdooConnectionError,\n OdooAuthenticationError,\n OdooRequestError,\n OdooValidationError\n)\n\ntry:\n odoo.env('res.partner').create({\n 'name': 'Test',\n 'email': 'invalid_email' # This will raise a validation error\n })\nexcept OdooValidationError as e:\n print(f\"Validation Error: {str(e)}\")\nexcept OdooConnectionError as e:\n print(f\"Connection Error: {str(e)}\")\nexcept OdooException as e:\n print(f\"General Odoo Error: {str(e)}\")\n```\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Author\n\n- **Name:** Fasil\n- **Email:** fasilwdr@hotmail.com\n- **WhatsApp:** [Contact](https://wa.me/966538952934)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2024] [Fasil] 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. ",
"summary": "A Python package to interact with Odoo via JSON-RPC.",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/fasilwdr/pyodoo_connector"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f478c9a8eb9dd4185d45f3b08f2f7f4ae55e510907a97d17778fc6d2d33e54fc",
"md5": "ed104017031a91ce6f75a5d24742776f",
"sha256": "5ab2e509da0d7ec2010631072c9e64873d987596e0deabd6effd03fc426da690"
},
"downloads": -1,
"filename": "pyodoo_connect-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed104017031a91ce6f75a5d24742776f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 11571,
"upload_time": "2024-12-08T12:25:49",
"upload_time_iso_8601": "2024-12-08T12:25:49.698406Z",
"url": "https://files.pythonhosted.org/packages/f4/78/c9a8eb9dd4185d45f3b08f2f7f4ae55e510907a97d17778fc6d2d33e54fc/pyodoo_connect-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "06e90cd2ab66ca98f5424862944747f9965f42bfa947553ffb41be1ffabd3170",
"md5": "7aeccc2b733276419add155cbda4cc6d",
"sha256": "9acef82aeedaf747ba8e5393defb295274126c93c338154e3b9b1e6b93287873"
},
"downloads": -1,
"filename": "pyodoo_connect-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "7aeccc2b733276419add155cbda4cc6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 12559,
"upload_time": "2024-12-08T12:25:51",
"upload_time_iso_8601": "2024-12-08T12:25:51.180066Z",
"url": "https://files.pythonhosted.org/packages/06/e9/0cd2ab66ca98f5424862944747f9965f42bfa947553ffb41be1ffabd3170/pyodoo_connect-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-08 12:25:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fasilwdr",
"github_project": "pyodoo_connector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "httpx",
"specs": [
[
">=",
"0.24.0"
]
]
}
],
"lcname": "pyodoo-connect"
}
