A Python library for the CeForms API.
Project description
Py Ce Forms Api
Quickstart
Introduction
The py-ce-forms-api
module allows you to interact with the CeForms API for form management. Before getting started, ensure you have obtained the necessary credentials:
- CE_FORMS_BASE_URL: The base URL for the CeForms API.
- CE_FORMS_TOKEN: Your authentication token for accessing the CeForms API.
Installation
You can install py-ce-forms-api
via pip:
pip install py-ce-forms-api
Usage
Once installed, you can start using the module in your Python code:
from py_ce_forms_api import CeFormsClient
# Initialize the client
ce_forms_client = CeFormsClient(base_url=<CE_FORMS_BASE_URL>, token=<CE_FORMS_TOKEN>)
# Example: Retrieve a list of forms
forms = ce_forms_client.query().with_sub_forms(False).with_limit(10).call()
for form in forms:
print(form)
Replace <CE_FORMS_BASE_URL> and <CE_FORMS_TOKEN> with your actual base URL and authentication token, respectively.
SDK Documentation
Development
pip install -e .
package building
python3 setup.py sdist bdist_wheel
package publishing
python3 -m twine upload --repository dist/*
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file py_ce_forms_api-0.0.9.tar.gz
.
File metadata
- Download URL: py_ce_forms_api-0.0.9.tar.gz
- Upload date:
- Size: 13.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.10.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a42384f679859dbcfb9240acc94e7787935280df46dbcf5b02f16b33d61900c9 |
|
MD5 | 0fd0f52d98c006383f9c9b5537e032fa |
|
BLAKE2b-256 | 6349ab8458fd9e20fef38fbaf52e8247f5b581cb15125d58435b25318435d348 |
File details
Details for the file py_ce_forms_api-0.0.9-py3-none-any.whl
.
File metadata
- Download URL: py_ce_forms_api-0.0.9-py3-none-any.whl
- Upload date:
- Size: 18.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.10.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3e1a2531b1f8d4200a90fa57b1185c7cccd545dd46336de1de51abbc2e338f7 |
|
MD5 | f4904d641ffe41956685d1745791d9b7 |
|
BLAKE2b-256 | 9b9be4833f2880944b4e9952eae1e2aa5799a46577c7e1c0e6c144440f5074e5 |