zoho-somconnexio-python-client 0.1.3

Python wrapper for SomConnexio's Zoho (using REST API)

:warning: WORK IN PROGRESS :warning:

This library is a Python wrapper for accessing Somconnexio's Zoho.

Resources

• CRMLeads

Installation

$ pip install zoho-somconnexio-python-client

Configuration Environment

You need define the Zoho CRM_CLIENT_ID, CRM_ORGANIZATION_ID, CRM_CLIENT_SECRET and ZOHO_CRM_STORE as environment variables. You need define:

ZOHO_CRM_CLIENT_ID=<YOUR CLIENT ID>
ZOHO_CRM_CLIENT_SECRET=<YOUR CLIENT SECRET>
ZOHO_CRM_ORGANIZATION_ID=<YOUR ORGANIZATION>
ZOHO_CRM_STORE=<YOUR PATH TO STORE TOKEN & LAYOUTS>

If this envvars are not defined, a exception will be raised with the name of the envvar not defined.

To execute functions, you need define:

ZOHO_APIKEY_ACTIVAT_FROM_ODOO=<FUNCTION_API_KEY>

Development

Setup environment

1. Install pyenv

curl https://pyenv.run | bash

2. Build the Python version

pyenv install  3.11.9

3. Create a virtualenv

pyenv virtualenv 3.11.9 zoho-somconnexio-python-client

4. Activate virtualenv

pyenv activate zoho-somconnexio-python-client

5. Install dependencies

pyenv exec pip install -r requirements-dev.txt

6. Install pre-commit hooks

pyenv exec pre-commit install

Run tests

To run the test you can run:

$ tox

Also you can run only the tests running:

$ pytest .

and if you want the coverage info:

$ pytest --cov .

Formatting

We use pre-commit to execute Black as formatter.

Release process

Update CHANGELOG.md following this steps:

1. Add any entries missing from merged merge requests.
2. Duplicate the [Unreleased] header.
3. Replace the second Unreleased with a version number followed by the current date. Copy the exact format from previous releases.

Then, you can release and publish the package to PyPi:

1. Update the __version__ var in __init__.py matching the version you specified in the CHANGELOG.
2. Open a merge request with these changes for the team to approve
3. Merge it, add a git tag on that merge commit and push it.
4. Once the pipeline has successfully passed, go approve the publish step.