Skip to main content

No project description provided

Project description

Celai Chatwoot Connector

celai-chatwoot is Python package that provides a connector for integrating the Cel.ai framework with Chatwoot. This allows seamless communication between your Cel.ai assistants and Chatwoot, enabling you to leverage Chatwoot's powerful customer support features.

Features

  • Easy integration with Chatwoot Bot API
  • Full stream mode support
  • Customizable bot settings

Installation

You can install the celai-chatwoot package using pip:

pip install celai-chatwoot

Usage

To use the celai-chatwoot connector, you need to create an instance of WootConnector and register it with the Cel.ai gateway. Below is an example of how to do this:

import os
from celai_chatwoot.connector import WootConnector

# Create an instance of WootConnector
conn = WootConnector(
    bot_name="Bot Name",
    access_key=os.environ.get("CHATWOOT_ACCESS_KEY"),
    account_id=os.environ.get("CHATWOOT_ACCOUNT_ID"),
    chatwoot_url=os.environ.get("CHATWOOT_URL"),
    bot_description="This is a test bot",
    stream_mode=StreamMode.FULL
)

# Register the connector with the gateway
gateway.register_connector(conn)

Environment Variables

The WootConnector requires the following environment variables to be set:

  • CHATWOOT_ACCESS_KEY: Your Chatwoot access key
  • CHATWOOT_ACCOUNT_ID: Your Chatwoot account ID
  • CHATWOOT_URL: The URL of your Chatwoot instance

Run your Cel.ai assistant, then a new Chatwoot bot called "Bot Name" will be created in your Chatwoot instance. Assign the bot to any Inbox you want to use it with.

Roadmap

Current version: 0.1.0 supports basic Chatwoot features such as sending and receiving text messages. Future versions will include the following features:

  • Image and file uploads
  • Custom attributes
  • Audio and video messages

Contributing

We welcome contributions to the celai-chatwoot project. If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

Special thanks to the Cel.ai and Chatwoot teams for their amazing frameworks and support.

Contact

For any questions or inquiries, please contact us at [alejamp@gmail.com].

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

celai_chatwoot-0.1.2.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

celai_chatwoot-0.1.2-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file celai_chatwoot-0.1.2.tar.gz.

File metadata

  • Download URL: celai_chatwoot-0.1.2.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.6

File hashes

Hashes for celai_chatwoot-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5fce0b414105c71cd61811f2a813a1b68a1c9519e92773e8257e3c5ddfaf780a
MD5 8f39dea7a5bfe842aee373201c4f47df
BLAKE2b-256 bf096c943f412c33a483f147a490c0a1050163f88051398ff684ff1f419000fd

See more details on using hashes here.

File details

Details for the file celai_chatwoot-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for celai_chatwoot-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8ae547751849f73bf64f5f21f03c4abc06db220972306d737def06c3c2ac8cca
MD5 8fcbfcd591c4334acfdaf18f755a7dfd
BLAKE2b-256 4d9c5ad55c5f0929303aaba826f65c5798c22dae659c1301354f40e5395139a9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page