clappia-api-tools 0.1.5__tar.gz

clappia_api_tools-0.1.5/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: clappia-api-tools
+Version: 0.1.5
+Summary: Python client for Clappia API integration
+Author-email: Rishabh Verma <rishabh.v@clappia.com>
+License: MIT
+Project-URL: Homepage, https://github.com/clappia-dev/clappia-tools
+Project-URL: Documentation, https://github.com/clappia-dev/clappia-tools#readme
+Project-URL: Repository, https://github.com/clappia-dev/clappia-tools.git
+Project-URL: Bug Tracker, https://github.com/clappia-dev/clappia-tools/issues
+Keywords: clappia,client,mcp,rest-apis,tools,workchat,agents
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-mock>=3.10.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.4.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Dynamic: license-file
+
+# Clappia Tools
+
+**LangChain integration for Clappia API**
+
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/clappia-tools)](https://pypi.org/project/clappia-tools/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## Overview
+
+Clappia Tools is a Python package that provides a unified client and a set of tools for seamless integration with the [Clappia API](https://www.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).
+
+---
+
+## Features
+
+-  **Unified API Client**: One client for all Clappia API operations.
+-  **Submission Management**: Create, edit, update owners, and change status of submissions.
+-  **App Definition Retrieval**: Fetch complete app structure and metadata.
+-  **Input Validation**: Built-in validation for IDs, emails, and status objects.
+-  **Extensible Tools**: Modular functions for each operation, easily integrated into agents or scripts.
+-  **Comprehensive Testing**: Includes unit and integration tests.
+
+---
+
+## Installation
+
+```bash
+pip install clappia-tools
+```
+
+Or, for development:
+
+```bash
+git clone https://github.com/clappia-dev/clappia-tools.git
+cd clappia-tools
+pip install -e .[dev]
+```
+
+---
+
+## Configuration
+
+You must provide your Clappia API credentials and workspace information directly when initializing the `ClappiaClient`:
+
+-  `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
+
+**Example:**
+
+```python
+from clappia_tools import ClappiaClient
+
+client = ClappiaClient(
+    api_key="your-api-key",
+    base_url="https://api.clappia.com",
+    workplace_id="your-workplace-id"
+)
+```
+---
+
+## Usage
+
+### Basic Client Usage
+
+```python
+from clappia_tools import ClappiaClient
+
+client = ClappiaClient(
+    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"},
+    email="user@example.com"
+)
+print(result)
+
+# Edit a submission
+result = client.edit_submission(
+    app_id="MFX093412",
+    submission_id="HGO51464561",
+    data={"department": "Marketing"},
+    email="user@example.com"
+)
+print(result)
+
+# Get app definition
+result = client.get_app_definition(app_id="MFX093412")
+print(result)
+```
+
+### Tool Functions
+
+You can also use the modular tool functions directly:
+
+```python
+from clappia_tools._tools import (
+    create_clappia_submission,
+    edit_clappia_submission,
+    get_app_definition,
+    update_clappia_submission_owners,
+    update_clappia_submission_status,
+)
+
+# Create a submission
+data = {"employee_name": "Jane Doe", "department": "HR"}
+response = create_clappia_submission("MFX093412", data, "user@example.com")
+print(response)
+
+# Update submission owners
+response = update_clappia_submission_owners(
+    "MFX093412", "HGO51464561", "admin@example.com", ["user1@company.com", "user2@company.com"]
+)
+print(response)
+
+# Update submission status
+response = update_clappia_submission_status(
+    "MFX093412", "HGO51464561", "admin@example.com", {"statusName": "Approved", "comments": "Reviewed."}
+)
+print(response)
+```
+
+---
+
+## Available Tools
+
+-  `create_clappia_submission(app_id, data, email)`
+-  `edit_clappia_submission(app_id, submission_id, data, email)`
+-  `get_app_definition(app_id, language="en", strip_html=True, include_tags=True)`
+-  `update_clappia_submission_owners(app_id, submission_id, requesting_user_email_address, email_ids)`
+-  `update_clappia_submission_status(app_id, submission_id, requesting_user_email_address, status)`
+
+See docstrings in each tool for detailed argument and return value descriptions.
+
+---
+
+## 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
+
+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.

clappia_api_tools-0.1.5/README.md

@@ -0,0 +1,176 @@
+# Clappia Tools
+
+**LangChain integration for Clappia API**
+
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/clappia-tools)](https://pypi.org/project/clappia-tools/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## Overview
+
+Clappia Tools is a Python package that provides a unified client and a set of tools for seamless integration with the [Clappia API](https://www.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).
+
+---
+
+## Features
+
+-  **Unified API Client**: One client for all Clappia API operations.
+-  **Submission Management**: Create, edit, update owners, and change status of submissions.
+-  **App Definition Retrieval**: Fetch complete app structure and metadata.
+-  **Input Validation**: Built-in validation for IDs, emails, and status objects.
+-  **Extensible Tools**: Modular functions for each operation, easily integrated into agents or scripts.
+-  **Comprehensive Testing**: Includes unit and integration tests.
+
+---
+
+## Installation
+
+```bash
+pip install clappia-tools
+```
+
+Or, for development:
+
+```bash
+git clone https://github.com/clappia-dev/clappia-tools.git
+cd clappia-tools
+pip install -e .[dev]
+```
+
+---
+
+## Configuration
+
+You must provide your Clappia API credentials and workspace information directly when initializing the `ClappiaClient`:
+
+-  `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
+
+**Example:**
+
+```python
+from clappia_tools import ClappiaClient
+
+client = ClappiaClient(
+    api_key="your-api-key",
+    base_url="https://api.clappia.com",
+    workplace_id="your-workplace-id"
+)
+```
+---
+
+## Usage
+
+### Basic Client Usage
+
+```python
+from clappia_tools import ClappiaClient
+
+client = ClappiaClient(
+    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"},
+    email="user@example.com"
+)
+print(result)
+
+# Edit a submission
+result = client.edit_submission(
+    app_id="MFX093412",
+    submission_id="HGO51464561",
+    data={"department": "Marketing"},
+    email="user@example.com"
+)
+print(result)
+
+# Get app definition
+result = client.get_app_definition(app_id="MFX093412")
+print(result)
+```
+
+### Tool Functions
+
+You can also use the modular tool functions directly:
+
+```python
+from clappia_tools._tools import (
+    create_clappia_submission,
+    edit_clappia_submission,
+    get_app_definition,
+    update_clappia_submission_owners,
+    update_clappia_submission_status,
+)
+
+# Create a submission
+data = {"employee_name": "Jane Doe", "department": "HR"}
+response = create_clappia_submission("MFX093412", data, "user@example.com")
+print(response)
+
+# Update submission owners
+response = update_clappia_submission_owners(
+    "MFX093412", "HGO51464561", "admin@example.com", ["user1@company.com", "user2@company.com"]
+)
+print(response)
+
+# Update submission status
+response = update_clappia_submission_status(
+    "MFX093412", "HGO51464561", "admin@example.com", {"statusName": "Approved", "comments": "Reviewed."}
+)
+print(response)
+```
+
+---
+
+## Available Tools
+
+-  `create_clappia_submission(app_id, data, email)`
+-  `edit_clappia_submission(app_id, submission_id, data, email)`
+-  `get_app_definition(app_id, language="en", strip_html=True, include_tags=True)`
+-  `update_clappia_submission_owners(app_id, submission_id, requesting_user_email_address, email_ids)`
+-  `update_clappia_submission_status(app_id, submission_id, requesting_user_email_address, status)`
+
+See docstrings in each tool for detailed argument and return value descriptions.
+
+---
+
+## 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
+
+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.

clappia_api_tools-0.1.5/clappia_api_tools.egg-info/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: clappia-api-tools
+Version: 0.1.5
+Summary: Python client for Clappia API integration
+Author-email: Rishabh Verma <rishabh.v@clappia.com>
+License: MIT
+Project-URL: Homepage, https://github.com/clappia-dev/clappia-tools
+Project-URL: Documentation, https://github.com/clappia-dev/clappia-tools#readme
+Project-URL: Repository, https://github.com/clappia-dev/clappia-tools.git
+Project-URL: Bug Tracker, https://github.com/clappia-dev/clappia-tools/issues
+Keywords: clappia,client,mcp,rest-apis,tools,workchat,agents
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-mock>=3.10.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.4.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Dynamic: license-file
+
+# Clappia Tools
+
+**LangChain integration for Clappia API**
+
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/clappia-tools)](https://pypi.org/project/clappia-tools/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## Overview
+
+Clappia Tools is a Python package that provides a unified client and a set of tools for seamless integration with the [Clappia API](https://www.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).
+
+---
+
+## Features
+
+-  **Unified API Client**: One client for all Clappia API operations.
+-  **Submission Management**: Create, edit, update owners, and change status of submissions.
+-  **App Definition Retrieval**: Fetch complete app structure and metadata.
+-  **Input Validation**: Built-in validation for IDs, emails, and status objects.
+-  **Extensible Tools**: Modular functions for each operation, easily integrated into agents or scripts.
+-  **Comprehensive Testing**: Includes unit and integration tests.
+
+---
+
+## Installation
+
+```bash
+pip install clappia-tools
+```
+
+Or, for development:
+
+```bash
+git clone https://github.com/clappia-dev/clappia-tools.git
+cd clappia-tools
+pip install -e .[dev]
+```
+
+---
+
+## Configuration
+
+You must provide your Clappia API credentials and workspace information directly when initializing the `ClappiaClient`:
+
+-  `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
+
+**Example:**
+
+```python
+from clappia_tools import ClappiaClient
+
+client = ClappiaClient(
+    api_key="your-api-key",
+    base_url="https://api.clappia.com",
+    workplace_id="your-workplace-id"
+)
+```
+---
+
+## Usage
+
+### Basic Client Usage
+
+```python
+from clappia_tools import ClappiaClient
+
+client = ClappiaClient(
+    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"},
+    email="user@example.com"
+)
+print(result)
+
+# Edit a submission
+result = client.edit_submission(
+    app_id="MFX093412",
+    submission_id="HGO51464561",
+    data={"department": "Marketing"},
+    email="user@example.com"
+)
+print(result)
+
+# Get app definition
+result = client.get_app_definition(app_id="MFX093412")
+print(result)
+```
+
+### Tool Functions
+
+You can also use the modular tool functions directly:
+
+```python
+from clappia_tools._tools import (
+    create_clappia_submission,
+    edit_clappia_submission,
+    get_app_definition,
+    update_clappia_submission_owners,
+    update_clappia_submission_status,
+)
+
+# Create a submission
+data = {"employee_name": "Jane Doe", "department": "HR"}
+response = create_clappia_submission("MFX093412", data, "user@example.com")
+print(response)
+
+# Update submission owners
+response = update_clappia_submission_owners(
+    "MFX093412", "HGO51464561", "admin@example.com", ["user1@company.com", "user2@company.com"]
+)
+print(response)
+
+# Update submission status
+response = update_clappia_submission_status(
+    "MFX093412", "HGO51464561", "admin@example.com", {"statusName": "Approved", "comments": "Reviewed."}
+)
+print(response)
+```
+
+---
+
+## Available Tools
+
+-  `create_clappia_submission(app_id, data, email)`
+-  `edit_clappia_submission(app_id, submission_id, data, email)`
+-  `get_app_definition(app_id, language="en", strip_html=True, include_tags=True)`
+-  `update_clappia_submission_owners(app_id, submission_id, requesting_user_email_address, email_ids)`
+-  `update_clappia_submission_status(app_id, submission_id, requesting_user_email_address, status)`
+
+See docstrings in each tool for detailed argument and return value descriptions.
+
+---
+
+## 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
+
+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.

clappia_api_tools-0.1.5/clappia_api_tools.egg-info/SOURCES.txt

@@ -0,0 +1,30 @@
+LICENSE
+README.md
+pyproject.toml
+clappia_api_tools.egg-info/PKG-INFO
+clappia_api_tools.egg-info/SOURCES.txt
+clappia_api_tools.egg-info/dependency_links.txt
+clappia_api_tools.egg-info/requires.txt
+clappia_api_tools.egg-info/top_level.txt
+clappia_tools/__init__.py
+clappia_tools/_enums/__init__.py
+clappia_tools/_enums/enums.py
+clappia_tools/_models/__init__.py
+clappia_tools/_models/model.py
+clappia_tools/_utils/__init__.py
+clappia_tools/_utils/api_utils.py
+clappia_tools/_utils/logging_utils.py
+clappia_tools/_utils/validators.py
+clappia_tools/client/__init__.py
+clappia_tools/client/app_definition_client.py
+clappia_tools/client/app_management_client.py
+clappia_tools/client/base_client.py
+clappia_tools/client/clappia_client.py
+clappia_tools/client/submission_client.py
+clappia_tools/tests/__init__.py
+clappia_tools/tests/integration/__init__.py
+clappia_tools/tests/integration/definition/test_tools_definition.py
+clappia_tools/tests/integration/submission/test_tools_submission.py
+clappia_tools/tests/unit/__init__.py
+clappia_tools/tests/unit/definition/test_validators.py
+clappia_tools/tests/unit/submission/test_client.py

clappia_api_tools-0.1.5/clappia_api_tools.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

clappia_api_tools-0.1.5/clappia_api_tools.egg-info/requires.txt

@@ -0,0 +1,20 @@
+requests>=2.31.0
+python-dotenv>=1.0.0
+pydantic>=2.0.0
+typing-extensions>=4.8.0
+
+[dev]
+pytest>=7.0.0
+black>=23.0.0
+flake8>=6.0.0
+mypy>=1.0.0
+pre-commit>=3.0.0
+
+[docs]
+mkdocs>=1.4.0
+mkdocs-material>=9.0.0
+
+[test]
+pytest>=7.0.0
+pytest-cov>=4.0.0
+pytest-mock>=3.10.0

clappia_api_tools-0.1.5/clappia_api_tools.egg-info/top_level.txt

@@ -0,0 +1 @@
+clappia_tools

clappia_api_tools-0.1.5/clappia_tools/__init__.py

@@ -0,0 +1,17 @@
+"""
+Clappia Tools - LangChain integration for Clappia API
+
+This package provides a unified client for interacting with Clappia APIs.
+"""
+
+from .client.clappia_client import ClappiaClient
+from .client.app_definition_client import AppDefinitionClient
+from .client.app_management_client import AppManagementClient
+from .client.submission_client import SubmissionClient
+
+__version__ = "0.1.5"
+__all__ = ["ClappiaClient", "AppDefinitionClient", "AppManagementClient", "SubmissionClient"]
+
+
+def __dir__():
+    return __all__