Skip to content

Installation & Quick Start

Installation

Install the DataScribe API using pip:

pip install datascribe-api

For development:

git clone https://github.com/DataScribe-Cloud/datascribe_api.git
cd datascribe_api
pip install -e .

Requirements

  • Python 3.11 or higher
  • An active DataScribe account and API key

Get Your API Key

  1. Visit https://datascribe.cloud/profile
  2. Log in or create an account
  3. Navigate to the API Keys section
  4. Generate a new API key
  5. Copy and save it securely

Configuration

Set your API key as an environment variable:

Linux/macOS

export DATASCRIBE_API_TOKEN="your_api_key_here"

Add to ~/.bashrc or ~/.zshrc for persistence:

echo 'export DATASCRIBE_API_TOKEN="your_api_key_here"' >> ~/.bashrc
source ~/.bashrc

Windows (PowerShell)

$env:DATASCRIBE_API_TOKEN="your_api_key_here"

For persistence:

[System.Environment]::SetEnvironmentVariable('DATASCRIBE_API_TOKEN', 'your_api_key_here', 'User')