CeFormsClient

Creating a client

To communicate with the Docker daemon, you first need to instantiate a client. The easiest way to do that is by instantiating a client class.

CeFormsClient reference

class py_ce_forms_api.client.CeFormsClient

A client form communication with a CeForms server.

This wraps the creation of an APIClient see api documentation for full details. By default when no argument was used, the following environment variables used are :

CE_FORMS_BASE_URL

URL to the CeForms API server

CE_FORMS_TOKEN

API token provided by a CeForms backend

Example:

>>> import py_ce_forms_api
>>> client = py_ce_forms_api.CeFormsClient()
>>> client.query().with_root('forms-account').with_sub_forms(False).with_limit(1).call()

Args:

base_url (str): URL to the CeForms API server. token (str): API token provided by a CeForms backend.

self()

Call the APIClient self method and return accesses information. see api documentation for full details.

query()

Returns the module to manage forms queries. see query documentation for full details.

mutation()

Returns the module to manage forms mutations. see query documentation for full details.

accounts()

Returns the module to manage CeForms users accounts. see accounts documentation for full details.

assets()

Returns the module to manage assets (files, media). see assets documentation for full details.

processing()

Returns the module to manage processing. see processing documentation for full details.