| Name | fiscus JSON |
| Version |
0.1.0a8
JSON |
| download |
| home_page | None |
| Summary | Fiscus is the definitive platform for AI-driven integrations, serving as your AI Integration Engineer. |
| upload_time | 2024-11-16 23:12:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Proprietary |
| keywords |
ai
api gateway
machine learning
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Fiscus SDK
The **Fiscus SDK** is your ultimate **AI Integration Engineer**. It seamlessly connects AI agents and language models to any API or service, simplifying and automating complex integrations. With Fiscus, you can dynamically orchestrate workflows, execute API operations, and build intelligent AI-powered applications without manual coding.
---
## Features
- **Dynamic API Operations**: Integrate with any API or service using connectors, enabling seamless task execution and workflow management.
- **AI Framework Integration**: Easily work with frameworks like LangChain, Crew, and OpenAI Function Calling.
- **Flexible Data Handling**: Retrieve responses in plain text or JSON format based on your configuration.
- **Comprehensive Callbacks**: Manage success, errors, authentication, streaming, logging, and debugging with ease.
- **Secure User Management**: Handle tokens, OAuth flows, and RBAC to support multiple users and services.
- **Effortless Connector Expansion**: Add new connectors without manual integration, empowering you to scale rapidly.
- **Advanced Orchestration**: Automatically route and manage workflows across unlimited connectors for scalable operations.
- **Robust Error Handling**: Handle issues dynamically with pre-built hooks and authentication retries.
---
## Installation
Install the Fiscus SDK via pip:
```
pip install fiscus-sdk
```
### System Requirements
- **Operating Systems**: Windows, macOS, Linux
- **Python Versions**: 3.9+
---
## Quick Start
### Example: Sending an Email
**Stateless Backend**
```python
from fiscus import FiscusClient
# Initialize the Fiscus client
client = FiscusClient(
api_key='YOUR_FISCUS_API_KEY',
user_id='user_123'
)
# Define email parameters
email_params = {
"emailData": {
"headers": [
{"name": "To", "value": "example@test.com"},
{"name": "From", "value": "support@fiscusflows.com"},
{"name": "Subject", "value": "Test Email"}
],
"body": {
"mimeType": "text/plain",
"data": "Hello, this is a test email sent via API."
}
}
}
# Execute the email operation
response = client.execute(
connector_name='gmail',
operation='send_email',
params=email_params
)
# Check response
if response.success:
print('Email sent successfully!')
else:
print(f'Error: {response.error_message}')
```
**Stateful Backend**
```python
from fiscus import FiscusClient, FiscusUser
# Initialize the Fiscus client
client = FiscusClient(api_key='YOUR_FISCUS_API_KEY')
# Create a user instance
user = FiscusUser(user_id='user_456', client=client)
# Execute the email operation
response = client.execute(
connector_name='gmail',
operation='send_email',
params=email_params
)
# Check response
if response.success:
print('Email sent successfully!')
else:
print(f'Error: {response.error_message}')
```
---
## Core Concepts
- **FiscusClient**: The main entry point for the SDK. Create and manage users, and execute operations.
- **FiscusUser**: Represents a user, managing user-specific authentication, preferences, and RBAC.
- **FiscusConnector**: Manages integrations with external APIs or services.
- **Operation**: A specific function provided by a connector, like sending an email.
- **Callbacks**: Customizable hooks for logging, debugging, and handling responses.
- **Dynamic Preferences**: Customize behavior per user for seamless API operations.
---
## AI-Driven Workflows
### Using `ai_execute` for Adaptive Automation
The `ai_execute` function dynamically interprets natural language instructions to execute workflows using connectors and language models. It supports sequential and conditional execution, making it the backbone for intelligent task automation.
### Benefits
- **Natural Language to Workflow**: Converts user input into actionable tasks.
- **Multi-LLM Compatibility**: Supports OpenAI, Anthropic, and others.
- **Memory Management**: Stateful and stateless configurations.
- **Flexible Execution**: Use callbacks and custom decision logic for complex workflows.
### Example
```python
from fiscus import FiscusClient, FiscusUser, FiscusLLMType
# Initialize Fiscus client and user
client = FiscusClient(api_key='YOUR_FISCUS_API_KEY')
user = FiscusUser(user_id='user_123', client=client)
# Execute AI workflow
response = client.ai_execute(
input="Schedule a meeting and email participants.",
llm_type=FiscusLLMType.OPENAI,
user=user
)
if response.success:
print("Workflow executed:", response.result)
else:
print(f"Error: {response.error_message}")
```
---
## Troubleshooting
### Common Installation Issues
- **Permission Errors**: Use `sudo` or a virtual environment.
- **Proxy Issues**: Configure pip to use proxy settings.
For additional help, contact [support@fiscusflows.com](mailto:support@fiscusflows.com).
---
## License
The Fiscus SDK is proprietary software developed by Fiscus Flows, Inc. By using this SDK, you agree to the terms and conditions outlined in the LICENSE file included with the distribution. For any licensing questions, contact [support@fiscusflows.com](mailto:support@fiscusflows.com).
Raw data
{
"_id": null,
"home_page": null,
"name": "fiscus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "AI, API Gateway, Machine Learning",
"author": null,
"author_email": "\"Fiscus Flows, Inc.\" <support@fiscusflows.com>",
"download_url": "https://files.pythonhosted.org/packages/e7/36/cb76240e3aece93bdc41b18ef250d03327204ce2f6b8ddb7f0a99ad1b804/fiscus-0.1.0a8.tar.gz",
"platform": null,
"description": "# Fiscus SDK\n\nThe **Fiscus SDK** is your ultimate **AI Integration Engineer**. It seamlessly connects AI agents and language models to any API or service, simplifying and automating complex integrations. With Fiscus, you can dynamically orchestrate workflows, execute API operations, and build intelligent AI-powered applications without manual coding.\n\n---\n\n## Features\n\n- **Dynamic API Operations**: Integrate with any API or service using connectors, enabling seamless task execution and workflow management.\n- **AI Framework Integration**: Easily work with frameworks like LangChain, Crew, and OpenAI Function Calling.\n- **Flexible Data Handling**: Retrieve responses in plain text or JSON format based on your configuration.\n- **Comprehensive Callbacks**: Manage success, errors, authentication, streaming, logging, and debugging with ease.\n- **Secure User Management**: Handle tokens, OAuth flows, and RBAC to support multiple users and services.\n- **Effortless Connector Expansion**: Add new connectors without manual integration, empowering you to scale rapidly.\n- **Advanced Orchestration**: Automatically route and manage workflows across unlimited connectors for scalable operations.\n- **Robust Error Handling**: Handle issues dynamically with pre-built hooks and authentication retries.\n\n---\n\n## Installation\n\nInstall the Fiscus SDK via pip:\n\n```\npip install fiscus-sdk\n```\n\n### System Requirements\n\n- **Operating Systems**: Windows, macOS, Linux\n- **Python Versions**: 3.9+\n\n---\n\n## Quick Start\n\n### Example: Sending an Email\n\n**Stateless Backend**\n\n```python\nfrom fiscus import FiscusClient\n\n# Initialize the Fiscus client\nclient = FiscusClient(\n\tapi_key='YOUR_FISCUS_API_KEY',\n\tuser_id='user_123'\n)\n\n# Define email parameters\nemail_params = {\n\t\"emailData\": {\n\t\t\"headers\": [\n\t\t\t{\"name\": \"To\", \"value\": \"example@test.com\"},\n\t\t\t{\"name\": \"From\", \"value\": \"support@fiscusflows.com\"},\n\t\t\t{\"name\": \"Subject\", \"value\": \"Test Email\"}\n\t\t],\n\t\t\"body\": {\n\t\t\t\"mimeType\": \"text/plain\",\n\t\t\t\"data\": \"Hello, this is a test email sent via API.\"\n\t\t}\n\t}\n}\n\n# Execute the email operation\nresponse = client.execute(\n\tconnector_name='gmail',\n\toperation='send_email',\n\tparams=email_params\n)\n\n# Check response\nif response.success:\n print('Email sent successfully!')\nelse:\n print(f'Error: {response.error_message}')\n```\n\n**Stateful Backend**\n\n```python\nfrom fiscus import FiscusClient, FiscusUser\n\n# Initialize the Fiscus client\nclient = FiscusClient(api_key='YOUR_FISCUS_API_KEY')\n\n# Create a user instance\nuser = FiscusUser(user_id='user_456', client=client)\n\n# Execute the email operation\nresponse = client.execute(\n\tconnector_name='gmail',\n\toperation='send_email',\n\tparams=email_params\n)\n\n# Check response\nif response.success:\n print('Email sent successfully!')\nelse:\n print(f'Error: {response.error_message}')\n```\n\n---\n\n## Core Concepts\n\n- **FiscusClient**: The main entry point for the SDK. Create and manage users, and execute operations.\n- **FiscusUser**: Represents a user, managing user-specific authentication, preferences, and RBAC.\n- **FiscusConnector**: Manages integrations with external APIs or services.\n- **Operation**: A specific function provided by a connector, like sending an email.\n- **Callbacks**: Customizable hooks for logging, debugging, and handling responses.\n- **Dynamic Preferences**: Customize behavior per user for seamless API operations.\n\n---\n\n## AI-Driven Workflows\n\n### Using `ai_execute` for Adaptive Automation\n\nThe `ai_execute` function dynamically interprets natural language instructions to execute workflows using connectors and language models. It supports sequential and conditional execution, making it the backbone for intelligent task automation.\n\n### Benefits\n\n- **Natural Language to Workflow**: Converts user input into actionable tasks.\n- **Multi-LLM Compatibility**: Supports OpenAI, Anthropic, and others.\n- **Memory Management**: Stateful and stateless configurations.\n- **Flexible Execution**: Use callbacks and custom decision logic for complex workflows.\n\n### Example\n\n```python\nfrom fiscus import FiscusClient, FiscusUser, FiscusLLMType\n\n# Initialize Fiscus client and user\nclient = FiscusClient(api_key='YOUR_FISCUS_API_KEY')\nuser = FiscusUser(user_id='user_123', client=client)\n\n# Execute AI workflow\nresponse = client.ai_execute(\n input=\"Schedule a meeting and email participants.\",\n llm_type=FiscusLLMType.OPENAI,\n user=user\n)\n\nif response.success:\n print(\"Workflow executed:\", response.result)\nelse:\n print(f\"Error: {response.error_message}\")\n```\n\n---\n\n## Troubleshooting\n\n### Common Installation Issues\n\n- **Permission Errors**: Use `sudo` or a virtual environment.\n- **Proxy Issues**: Configure pip to use proxy settings.\n\nFor additional help, contact [support@fiscusflows.com](mailto:support@fiscusflows.com).\n\n---\n\n## License\n\nThe Fiscus SDK is proprietary software developed by Fiscus Flows, Inc. By using this SDK, you agree to the terms and conditions outlined in the LICENSE file included with the distribution. For any licensing questions, contact [support@fiscusflows.com](mailto:support@fiscusflows.com).\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "Fiscus is the definitive platform for AI-driven integrations, serving as your AI Integration Engineer.",
"version": "0.1.0a8",
"project_urls": null,
"split_keywords": [
"ai",
" api gateway",
" machine learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88f663c57bf0d5e21b232f93199ca0b26647130a67dbcb581fbadf312846973e",
"md5": "dae30edc1f9fc4375157bef1ac128ef3",
"sha256": "3819571821a08602cc4f2d05035cbacb21d28a8dce02e20c5e557b06923ab53f"
},
"downloads": -1,
"filename": "fiscus-0.1.0a8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dae30edc1f9fc4375157bef1ac128ef3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 54688,
"upload_time": "2024-11-16T23:12:51",
"upload_time_iso_8601": "2024-11-16T23:12:51.874712Z",
"url": "https://files.pythonhosted.org/packages/88/f6/63c57bf0d5e21b232f93199ca0b26647130a67dbcb581fbadf312846973e/fiscus-0.1.0a8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e736cb76240e3aece93bdc41b18ef250d03327204ce2f6b8ddb7f0a99ad1b804",
"md5": "5b96d2ba359ca28b62dff39a1c2ee1c2",
"sha256": "b1a7e6515145b73ffa201bf5429a14070a859f8577ec4baf3dc646e1dea76651"
},
"downloads": -1,
"filename": "fiscus-0.1.0a8.tar.gz",
"has_sig": false,
"md5_digest": "5b96d2ba359ca28b62dff39a1c2ee1c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 40415621,
"upload_time": "2024-11-16T23:12:55",
"upload_time_iso_8601": "2024-11-16T23:12:55.051898Z",
"url": "https://files.pythonhosted.org/packages/e7/36/cb76240e3aece93bdc41b18ef250d03327204ce2f6b8ddb7f0a99ad1b804/fiscus-0.1.0a8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-16 23:12:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fiscus"
}
