consumableai 0.1.1

No project description provided

ConsumableAI

Overview

Consumable AI is an SDK that can be easily integrated into the self hosted BI tools which gives enterprises the power to talk to the databases in natural language. This will make exploratory data analyses easy to perform and remove the barrier of acquiring SQL skills and database know-how.

Installation

A Python library for seamless integration with ConsumableAI platform.

To get started, follow these steps:

1. Set up a virtual environment for your project:

   $ python3 -m venv myenv $ source myenv/bin/activate

2. Install the ConsumableAI library using pip:

   $ pip install consumableai

   Please ensure you have a working internet connection.

3. Obtain an API key by visiting https://platform.consumableai.com and creating an account. The API key will be used to authenticate your requests.

4. Initialize the ConsumableAI library:

   $ consumableai init

   This command will prompt you to enter various database-related values. The library will create the table schema for your data. Please note that ConsumableAI does not store your data directly. Instead, it creates the table schema and shares a link to a spreadsheet. You can make changes to the spreadsheet, and when you're ready, inform us to update the schema accordingly.

   The spreadsheet link will be provided after initialization.

5. Start utilizing the ConsumableAI library in your Python code to interact with the platform and access your data.

   Example usage:

   import consumableai
   
   # Initialize the ConsumableAI client
   client = consumableai.Client(api_key='YOUR_API_KEY')
   
   # Perform operations with the client
   ...
   

Replace 'YOUR_API_KEY' with the API key you obtained.

For more information and documentation, please visit our website at example.com.

Happy data exploration with ConsumableAI!

Feel free to modify and adapt this description to fit your specific library and instructions.