# Clappia API Tools
**Clappia APIs SDK**
[](https://pypi.org/project/clappia-api-tools/)
[](LICENSE)
---
## Overview
Clappia API Tools is a Python package that provides a set of clients for seamless integration with the [Clappia API](https://developer.clappia.com/). It enables developers to automate workflows, manage submissions, and interact with Clappia apps programmatically. The package is designed for use in automation, data integration, and agent-based systems (e.g., LangChain agents, MCP).
---
## Features
- **Multiple API Clients**: Dedicated clients for each Clappia API operation.
- **Submission Management**: Create, edit, update owners, and change status of submissions.
- **App Definition Retrieval**: Fetch complete app structure and metadata and manage the app structure via fields and sections updates.
- **Workflow Management**: Retrieve, create, modify, and manage workflow definitions and steps.
- **Analytics Management**: Add, update, and reorder charts and analytics configurations.
---
## Available Clients
- `SubmissionClient`: Manage submissions (create, edit, update owners, change status)
- `AppDefinitionClient`: Retrieve app definitions and metadata and Manage app structure (fields, sections, creation)
- `WorkflowDefinitionClient`: Manage workflow definitions (get, add, update, reorder workflow steps)
- `AnalyticsClient`: Manage analytics and charts (add, update, reorder charts)
---
## Documentation
- [Submission Client Reference](docs/submission_client.md)
- [App Definition Client Reference](docs/app_definition_client.md)
- [Workflow Definition Client Reference](docs/workflow_definition_client.md)
- [Analytics Client Reference](docs/analytics_client.md)
- [Setup, Testing, and Publish Reference](docs/setup_testing_publishing.md)
---
## Installation
```bash
pip install clappia-api-tools
```
Or, for development:
```bash
git clone https://github.com/clappia-dev/clappia-api-tools.git
cd clappia-api-tools
pip install -e ."[dev]"
```
---
## Configuration
You must provide your Clappia API credentials and workspace information directly when initializing any client:
- `api_key`: Your Clappia API key
- `base_url`: The base URL for the Clappia API (e.g., `https://api.clappia.com`)
---
## Usage
### SubmissionClient Example
```python
from clappia_api_tools.client.submission_client import SubmissionClient
client = SubmissionClient(
api_key="your-api-key",
base_url="https://api.clappia.com",
)
# Create a submission
result = client.create_submission(
app_id="MFX093412",
data={"employee_name": "John Doe", "department": "Engineering"},
)
print(result)
```
### AppDefinitionClient Example
```python
from clappia_api_tools.client.app_definition_client import AppDefinitionClient
client = AppDefinitionClient(
api_key="your-api-key",
base_url="https://api.clappia.com",
)
# Get app definition
result = client.get_definition(app_id="MFX093412")
print(result)
```
### WorkflowDefinitionClient Example
```python
from clappia_api_tools.client.workflow_definition_client import WorkflowDefinitionClient
client = WorkflowDefinitionClient(
api_key="your-api-key",
base_url="https://api.clappia.com",
)
# Get workflow definition
result = client.get_workflow(
app_id="MFX093412",
trigger_type="submissionCreated",
)
print(result)
# Add a workflow step
add_result = client.add_step(
app_id="MFX093412",
trigger_type="submissionCreated",
node_type="Email",
)
print(add_result)
```
### AnalyticsClient Example
```python
from clappia_api_tools.client.analytics_client import AnalyticsClient
client = AnalyticsClient(
api_key="your-api-key",
base_url="https://api.clappia.com",
)
# Add a chart
result = client.add_chart(
app_id="MFX093412",
chart_type="Bar",
chart_title="Sales Overview"
)
print(result)
# Update chart configuration
update_data = {
"chart_title": "Updated Sales Overview",
"dimensions": ["region"],
"metrics": ["sales_amount"]
}
update_result = client.update_chart(
app_id="MFX093412",
chart_index=0,
update_data=update_data
)
print(update_result)
```
---
## Contributing
1. Fork the repository and create your branch.
2. Write clear, well-documented code and tests.
3. Run `pytest` and ensure all tests pass.
4. Submit a pull request with a clear description of your changes.
---
## License
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "clappia-api-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "clappia, client, mcp, rest-apis, tools, workchat, agents",
"author": null,
"author_email": "Rishabh Verma <rishabh.v@clappia.com>",
"download_url": "https://files.pythonhosted.org/packages/71/08/c46866190dcf03ff2b00d4fe2fa350a06d7829e8f3f54ccd97084ab20b4a/clappia_api_tools-2.0.8.tar.gz",
"platform": null,
"description": "# Clappia API Tools\n\n**Clappia APIs SDK**\n\n[](https://pypi.org/project/clappia-api-tools/)\n[](LICENSE)\n\n---\n\n## Overview\n\nClappia API Tools is a Python package that provides a set of clients for seamless integration with the [Clappia API](https://developer.clappia.com/). It enables developers to automate workflows, manage submissions, and interact with Clappia apps programmatically. The package is designed for use in automation, data integration, and agent-based systems (e.g., LangChain agents, MCP).\n\n---\n\n## Features\n\n- **Multiple API Clients**: Dedicated clients for each Clappia API operation.\n- **Submission Management**: Create, edit, update owners, and change status of submissions.\n- **App Definition Retrieval**: Fetch complete app structure and metadata and manage the app structure via fields and sections updates.\n- **Workflow Management**: Retrieve, create, modify, and manage workflow definitions and steps.\n- **Analytics Management**: Add, update, and reorder charts and analytics configurations.\n\n---\n\n## Available Clients\n\n- `SubmissionClient`: Manage submissions (create, edit, update owners, change status)\n- `AppDefinitionClient`: Retrieve app definitions and metadata and Manage app structure (fields, sections, creation)\n- `WorkflowDefinitionClient`: Manage workflow definitions (get, add, update, reorder workflow steps)\n- `AnalyticsClient`: Manage analytics and charts (add, update, reorder charts)\n\n---\n\n## Documentation\n\n- [Submission Client Reference](docs/submission_client.md)\n- [App Definition Client Reference](docs/app_definition_client.md)\n- [Workflow Definition Client Reference](docs/workflow_definition_client.md)\n- [Analytics Client Reference](docs/analytics_client.md)\n- [Setup, Testing, and Publish Reference](docs/setup_testing_publishing.md)\n\n---\n\n## Installation\n\n```bash\npip install clappia-api-tools\n```\n\nOr, for development:\n\n```bash\ngit clone https://github.com/clappia-dev/clappia-api-tools.git\ncd clappia-api-tools\npip install -e .\"[dev]\"\n```\n\n---\n\n## Configuration\n\nYou must provide your Clappia API credentials and workspace information directly when initializing any client:\n\n- `api_key`: Your Clappia API key\n- `base_url`: The base URL for the Clappia API (e.g., `https://api.clappia.com`)\n\n---\n\n## Usage\n\n### SubmissionClient Example\n\n```python\nfrom clappia_api_tools.client.submission_client import SubmissionClient\n\nclient = SubmissionClient(\n api_key=\"your-api-key\",\n base_url=\"https://api.clappia.com\",\n)\n\n# Create a submission\nresult = client.create_submission(\n app_id=\"MFX093412\",\n data={\"employee_name\": \"John Doe\", \"department\": \"Engineering\"},\n)\nprint(result)\n```\n\n### AppDefinitionClient Example\n\n```python\nfrom clappia_api_tools.client.app_definition_client import AppDefinitionClient\n\nclient = AppDefinitionClient(\n api_key=\"your-api-key\",\n base_url=\"https://api.clappia.com\",\n)\n\n# Get app definition\nresult = client.get_definition(app_id=\"MFX093412\")\nprint(result)\n```\n\n### WorkflowDefinitionClient Example\n\n```python\nfrom clappia_api_tools.client.workflow_definition_client import WorkflowDefinitionClient\n\nclient = WorkflowDefinitionClient(\n api_key=\"your-api-key\",\n base_url=\"https://api.clappia.com\",\n)\n\n# Get workflow definition\nresult = client.get_workflow(\n app_id=\"MFX093412\",\n trigger_type=\"submissionCreated\",\n)\nprint(result)\n\n# Add a workflow step\nadd_result = client.add_step(\n app_id=\"MFX093412\",\n trigger_type=\"submissionCreated\",\n node_type=\"Email\",\n)\nprint(add_result)\n```\n\n### AnalyticsClient Example\n\n```python\nfrom clappia_api_tools.client.analytics_client import AnalyticsClient\n\nclient = AnalyticsClient(\n api_key=\"your-api-key\",\n base_url=\"https://api.clappia.com\",\n)\n\n# Add a chart\nresult = client.add_chart(\n app_id=\"MFX093412\",\n chart_type=\"Bar\",\n chart_title=\"Sales Overview\"\n)\nprint(result)\n\n# Update chart configuration\nupdate_data = {\n \"chart_title\": \"Updated Sales Overview\",\n \"dimensions\": [\"region\"],\n \"metrics\": [\"sales_amount\"]\n}\nupdate_result = client.update_chart(\n app_id=\"MFX093412\",\n chart_index=0,\n update_data=update_data\n)\nprint(update_result)\n```\n\n---\n\n## Contributing\n\n1. Fork the repository and create your branch.\n2. Write clear, well-documented code and tests.\n3. Run `pytest` and ensure all tests pass.\n4. Submit a pull request with a clear description of your changes.\n\n---\n\n## License\n\nThis project is licensed under the MIT License. See [LICENSE](LICENSE) for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for Clappia API integration",
"version": "2.0.8",
"project_urls": {
"Bug Tracker": "https://github.com/clappia-dev/clappia-api-tools/issues",
"Documentation": "https://github.com/clappia-dev/clappia-api-tools#readme",
"Homepage": "https://github.com/clappia-dev/clappia-api-tools",
"Repository": "https://github.com/clappia-dev/clappia-api-tools.git"
},
"split_keywords": [
"clappia",
" client",
" mcp",
" rest-apis",
" tools",
" workchat",
" agents"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d4575d95ff7be87f60d9909c9b8502bb0e47d59f93c291df8b44152e84ef6b4c",
"md5": "d39cb041edbb451f9916ce0ef82679ad",
"sha256": "dfa30cc44f469c5895a6d1781cfeba0bcc1eb5672d80680163d2def05ceb6f83"
},
"downloads": -1,
"filename": "clappia_api_tools-2.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d39cb041edbb451f9916ce0ef82679ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 96479,
"upload_time": "2025-09-19T06:37:44",
"upload_time_iso_8601": "2025-09-19T06:37:44.052448Z",
"url": "https://files.pythonhosted.org/packages/d4/57/5d95ff7be87f60d9909c9b8502bb0e47d59f93c291df8b44152e84ef6b4c/clappia_api_tools-2.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7108c46866190dcf03ff2b00d4fe2fa350a06d7829e8f3f54ccd97084ab20b4a",
"md5": "c97b60082c40278f40d79e9b5d300b79",
"sha256": "34e959272b3df491134ded0540c50af5db1d9aa3a10c0f219ae1b7e4f5cf8018"
},
"downloads": -1,
"filename": "clappia_api_tools-2.0.8.tar.gz",
"has_sig": false,
"md5_digest": "c97b60082c40278f40d79e9b5d300b79",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 76269,
"upload_time": "2025-09-19T06:37:45",
"upload_time_iso_8601": "2025-09-19T06:37:45.674304Z",
"url": "https://files.pythonhosted.org/packages/71/08/c46866190dcf03ff2b00d4fe2fa350a06d7829e8f3f54ccd97084ab20b4a/clappia_api_tools-2.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-19 06:37:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "clappia-dev",
"github_project": "clappia-api-tools",
"github_not_found": true,
"lcname": "clappia-api-tools"
}
JSON
