Metadata-Version: 2.1
Name: py-ce-forms-api
Version: 0.0.7
Summary: A Python library for the CeForms API.
Home-page: UNKNOWN
Author: codeffekt
Author-email: contact@codeffekt.com
License: UNKNOWN
Keywords: python,ceforms,api
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi
Requires-Dist: requests
Requires-Dist: uvicorn

# Py Ce Forms Api

## Development

 > pip install -e .

### package building

 > python3 setup.py sdist bdist_wheel

### package publishing

 > python3 -m twine upload --repository <repository> dist/*

## 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:

```bash
pip install py-ce-forms-api
```

### Usage

Once installed, you can start using the module in your Python code:

```python
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.


