clappia-api-tools


Nameclappia-api-tools JSON
Version 1.0.1 PyPI version JSON
download
home_pageNone
SummaryPython client for Clappia API integration
upload_time2025-07-21 05:27:24
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT
keywords clappia client mcp rest-apis tools workchat agents
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Clappia API Tools

**Clappia APIs SDK**

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/clappia-api-tools)](https://pypi.org/project/clappia-api-tools/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](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.
-  **Input Validation**: Built-in validation for IDs, emails, and status objects.
-  **Comprehensive Testing**: Includes unit and integration tests.

---

## Available Clients

-  `SubmissionClient`: Manage submissions (create, edit, update owners, change status)
-  `AppDefinitionClient`: Retrieve app definitions and metadata and  Manage app structure (fields, sections, creation)

---

## Documentation

-  [Submission Client Reference](docs/submission_client.md)
-  [App Definition Client Reference](docs/app_definition_client.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]"
```

---

## First-Time Setup

Before using or testing Clappia API Tools, set up your environment variables. Create a `.env` file in the project root with the following content:

```env
CLAPPIA_API_KEY=your-api-key
CLAPPIA_BASE_URL=https://api.clappia.com
CLAPPIA_WORKPLACE_ID=your-workplace-id
```

-  Replace `your-api-key` and `your-workplace-id` with your actual Clappia credentials.
-  The `.env` file is included in `.gitignore` and will not be committed.
-  The package uses [python-dotenv](https://pypi.org/project/python-dotenv/) to load these variables automatically if present.

---

## 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`)
-  `workplace_id`: Your Clappia workplace ID

---

## 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",
    workplace_id="your-workplace-id"
)

# Create a submission
result = client.create_submission(
    app_id="MFX093412",
    data={"employee_name": "John Doe", "department": "Engineering"},
    requesting_user_email_address="user@example.com"
)
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",
    workplace_id="your-workplace-id"
)

# Get app definition
result = client.get_definition(app_id="MFX093412")
print(result)
```

---

## Input Validation

-  **App ID**: Must be uppercase letters and numbers (e.g., `MFX093412`).
-  **Submission ID**: Must be uppercase letters and numbers (e.g., `HGO51464561`).
-  **Email**: Must be a valid email address.
-  **Status**: Must be a dictionary with a non-empty `statusName` or `name` field.

Invalid inputs will return descriptive error messages.

---

## Testing

Before running tests, ensure your `.env` file is present in the project root with valid credentials. The test suite will load environment variables automatically.

Run all tests (unit and integration):

```bash
pytest
```

---

## 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/2a/1e/5aec317d71b3f83a3dd1d2dd8ddaea6523b0c4f56fae39aa2b2ebba61220/clappia_api_tools-1.0.1.tar.gz",
    "platform": null,
    "description": "# Clappia API Tools\n\n**Clappia APIs SDK**\n\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/clappia-api-tools)](https://pypi.org/project/clappia-api-tools/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](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-  **Input Validation**: Built-in validation for IDs, emails, and status objects.\n-  **Comprehensive Testing**: Includes unit and integration tests.\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\n---\n\n## Documentation\n\n-  [Submission Client Reference](docs/submission_client.md)\n-  [App Definition Client Reference](docs/app_definition_client.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## First-Time Setup\n\nBefore using or testing Clappia API Tools, set up your environment variables. Create a `.env` file in the project root with the following content:\n\n```env\nCLAPPIA_API_KEY=your-api-key\nCLAPPIA_BASE_URL=https://api.clappia.com\nCLAPPIA_WORKPLACE_ID=your-workplace-id\n```\n\n-  Replace `your-api-key` and `your-workplace-id` with your actual Clappia credentials.\n-  The `.env` file is included in `.gitignore` and will not be committed.\n-  The package uses [python-dotenv](https://pypi.org/project/python-dotenv/) to load these variables automatically if present.\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-  `workplace_id`: Your Clappia workplace ID\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    workplace_id=\"your-workplace-id\"\n)\n\n# Create a submission\nresult = client.create_submission(\n    app_id=\"MFX093412\",\n    data={\"employee_name\": \"John Doe\", \"department\": \"Engineering\"},\n    requesting_user_email_address=\"user@example.com\"\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    workplace_id=\"your-workplace-id\"\n)\n\n# Get app definition\nresult = client.get_definition(app_id=\"MFX093412\")\nprint(result)\n```\n\n---\n\n## Input Validation\n\n-  **App ID**: Must be uppercase letters and numbers (e.g., `MFX093412`).\n-  **Submission ID**: Must be uppercase letters and numbers (e.g., `HGO51464561`).\n-  **Email**: Must be a valid email address.\n-  **Status**: Must be a dictionary with a non-empty `statusName` or `name` field.\n\nInvalid inputs will return descriptive error messages.\n\n---\n\n## Testing\n\nBefore running tests, ensure your `.env` file is present in the project root with valid credentials. The test suite will load environment variables automatically.\n\nRun all tests (unit and integration):\n\n```bash\npytest\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": "1.0.1",
    "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": "0e81476729bf27eac5d5f7721a469da6c97443df2d62717b68d078e8c24edcd6",
                "md5": "afffca9c5594eacc5573d1e1b3654a48",
                "sha256": "d44416cbc920220f4e2153a2aa0c56d0aebb0477f0035861c36b367d8170369c"
            },
            "downloads": -1,
            "filename": "clappia_api_tools-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "afffca9c5594eacc5573d1e1b3654a48",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 28819,
            "upload_time": "2025-07-21T05:27:23",
            "upload_time_iso_8601": "2025-07-21T05:27:23.046263Z",
            "url": "https://files.pythonhosted.org/packages/0e/81/476729bf27eac5d5f7721a469da6c97443df2d62717b68d078e8c24edcd6/clappia_api_tools-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2a1e5aec317d71b3f83a3dd1d2dd8ddaea6523b0c4f56fae39aa2b2ebba61220",
                "md5": "5ce5e3e40e4d72eabb0898f187c0daf9",
                "sha256": "9da46792649be385079c4c0574617986552bc5a0d33ff21a20d014705d1e32b2"
            },
            "downloads": -1,
            "filename": "clappia_api_tools-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5ce5e3e40e4d72eabb0898f187c0daf9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 24612,
            "upload_time": "2025-07-21T05:27:24",
            "upload_time_iso_8601": "2025-07-21T05:27:24.482043Z",
            "url": "https://files.pythonhosted.org/packages/2a/1e/5aec317d71b3f83a3dd1d2dd8ddaea6523b0c4f56fae39aa2b2ebba61220/clappia_api_tools-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-21 05:27:24",
    "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"
}
        
Elapsed time: 1.66790s