Metadata-Version: 2.0
Name: alkivi-odoo-client
Version: 1.0.1
Summary: Odoo python client used at Alkivi
Home-page: https://github.com/alkivi-sas/python-alkivi-odoo
Author: Anthony Martinet
Author-email: anthony@alkivi.fr
License: LGPLv3
Keywords: alkivi odoo
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: alkivi-logger
Requires-Dist: odoorpc
Provides-Extra: dev
Provides-Extra: test

python-alkivi-odoo-client
==========================

[![Build Status](https://travis-ci.org/alkivi-sas/python-alkivi-odoo-client.svg?branch=master)](https://travis-ci.org/alkivi-sas/python-alkivi-odoo-client)
[![Requirements Status](https://requires.io/github/alkivi-sas/python-alkivi-odoo-client/requirements.svg?branch=master)](https://requires.io/github/alkivi-sas/python-alkivi-odoo-client/requirements/?branch=master)

Odoo python client used at Alkivi.
Based on odoorpc on which we add additional fonction.

## Package

Example

```python
from alkivi.odoo import client as odoo

# Using default configuration
client = odoo.Client()

# Using specific endpoint
client = odoo.Client(endpoint='prod')
# TODO
```

## Credentials

Credentials are fetched from, in priority order:
- ./odoo.conf (script directory)
- $HOME/.odoo.conf
- /etc/odoo.conf

Example

```ini
[default]
; general configuration: default endpoint
endpoint=dev

[dev]
; configuration specific to 'dev' endpoint
protocol=jsonrpc+ssl
port=443
url=odoo.domain
version=8.0
db=odooDatabase
user=pdooUser
password=AweSomePasswOrd

[prod]
; other configuration
```

## Tests

Testing is set up using [pytest](http://pytest.org) and coverage is handled
with the pytest-cov plugin.

Run your tests with ```py.test``` in the root directory.

Coverage is ran by default and is set in the ```pytest.ini``` file.
To see an html output of coverage open ```htmlcov/index.html``` after running the tests.

TODO

## Travis CI

There is a ```.travis.yml``` file that is set up to run your tests for python 2.7
and python 3.2, should you choose to use it.

TODO


