py-ce-forms-api

Name	py-ce-forms-api JSON
Version	0.1.6 JSON
	download
home_page	None
Summary	A Python library for the CeForms API.
upload_time	2024-12-05 08:05:55
maintainer	None
docs_url	None
author	codeffekt
requires_python	None
license	None
keywords	python ceforms api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

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

## SDK Documentation

See *[CeForms SDK for Python](https://py-ce-forms-api.readthedocs.io/en/latest/index.html)*

## Development

 > pip install -e .

### package building

 > python3 setup.py sdist bdist_wheel

### package publishing

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



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "py-ce-forms-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "python, ceforms, api",
    "author": "codeffekt",
    "author_email": "contact@codeffekt.com",
    "download_url": "https://files.pythonhosted.org/packages/a0/de/58de07106b4b3e80860d80bc6d7c4403f7128b3a71c646152698a731ddb7/py_ce_forms_api-0.1.6.tar.gz",
    "platform": null,
    "description": "# Py Ce Forms Api\n\n## Quickstart\n\n### Introduction\n\nThe `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:\n\n- **CE_FORMS_BASE_URL**: The base URL for the CeForms API.\n- **CE_FORMS_TOKEN**: Your authentication token for accessing the CeForms API.\n \n### Installation\n\nYou can install `py-ce-forms-api` via pip:\n\n```bash\npip install py-ce-forms-api\n```\n\n### Usage\n\nOnce installed, you can start using the module in your Python code:\n\n```python\nfrom py_ce_forms_api import CeFormsClient\n\n# Initialize the client\nce_forms_client = CeFormsClient(base_url=<CE_FORMS_BASE_URL>, token=<CE_FORMS_TOKEN>)\n\n# Example: Retrieve a list of forms\nforms = ce_forms_client.query().with_sub_forms(False).with_limit(10).call()\nfor form in forms:\n    print(form)\n```\n\nReplace <CE_FORMS_BASE_URL> and <CE_FORMS_TOKEN> with your actual base URL and authentication token, respectively.\n\n## SDK Documentation\n\nSee *[CeForms SDK for Python](https://py-ce-forms-api.readthedocs.io/en/latest/index.html)*\n\n## Development\n\n > pip install -e .\n\n### package building\n\n > python3 setup.py sdist bdist_wheel\n\n### package publishing\n\n > python3 -m twine upload --repository <repository> dist/*\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python library for the CeForms API.",
    "version": "0.1.6",
    "project_urls": null,
    "split_keywords": [
        "python",
        " ceforms",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ade937c6269e22f8823aa0a7301be7635ed38c26c04d3d626f033fdd40cbee4b",
                "md5": "d0ea320dc57f5e033e4fd3b7e917a8b9",
                "sha256": "40aa3d81dec1ebad476af8206329e00f9f8ea3e6c96a87d63b5f8648d23a7794"
            },
            "downloads": -1,
            "filename": "py_ce_forms_api-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d0ea320dc57f5e033e4fd3b7e917a8b9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 24876,
            "upload_time": "2024-12-05T08:05:54",
            "upload_time_iso_8601": "2024-12-05T08:05:54.205308Z",
            "url": "https://files.pythonhosted.org/packages/ad/e9/37c6269e22f8823aa0a7301be7635ed38c26c04d3d626f033fdd40cbee4b/py_ce_forms_api-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a0de58de07106b4b3e80860d80bc6d7c4403f7128b3a71c646152698a731ddb7",
                "md5": "0f2357babd0c4c9fbe334ace2079815a",
                "sha256": "db6c0064e5687fbb5f6e03b59ca15a95c4f60bc5ae0b654e95815920c9d280b2"
            },
            "downloads": -1,
            "filename": "py_ce_forms_api-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "0f2357babd0c4c9fbe334ace2079815a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 16526,
            "upload_time": "2024-12-05T08:05:55",
            "upload_time_iso_8601": "2024-12-05T08:05:55.630062Z",
            "url": "https://files.pythonhosted.org/packages/a0/de/58de07106b4b3e80860d80bc6d7c4403f7128b3a71c646152698a731ddb7/py_ce_forms_api-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-05 08:05:55",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "py-ce-forms-api"
}