README.md

SuitePY

Suite PY is a simple Python client for SuiteCRM API.

How to prepare the environment on Linux (Debian)

In this section is described how to get the development environment ready on Debian based systems.

It's recommended to use virtualenv and pip packages. You can install this two dependencies runnig:

sudo apt update
sudo apt install virtualenv python3-pip

Once you have virtualenv and pip tools ready it's time to prepare the virtual environment to run the application.
Following we create a virtual environment and install all Python dependencies:

cd SuitePY
virtualenv env
source env/bin/activate
pip install -r requirements.txt

PDF Templates support

To be able to use get_pdf_template method, you need to install a custom WebService on your SuiteCRM instance, you can check SuitePY-Service README.

Edit suitepy.ini config file and change the url parameter to https://crm.example.net/custom/service/suitepy/rest.php.