Welcome to pyEchosign’s documentation!¶
About¶
A Python module for connecting to the Adobe Echosign REST API, without the hassle of dealing with the JSON formatting for requests/responses and the REST endpoints and their varying requirements
Documentation¶
The most up to date documentation can be found on pyEchosign’s RTD page.
Notes¶
JSON Deserialization¶
Most classes contain two methods to facilitate the process of receiving
JSON from the REST API and turning that into Python classes. One,
json_to_X()
will handle the JSON formatting for a single instance,
while the second - json_to_Xs()
processes JSON for multiple
instances. Generally, the latter is simply returning a list
comprehension that calls the former.
While this is primarily useful for internal purposes - every method
retrieving an Agreement
from the API will call
Agreement.json_to_agreement()
for example - the methods are not
private and available for use. Any changes to their interface will only
be made following deprecation warnings.
Internal Methods and Classes¶
All protected and private methods; and any classes, functions, or
methods found under pyEchosign.utils
are subject to change without
deprecation warnings however.
Any content in between double quotes (“like this”) is taken from the Echosign API documentation.