https://github.com/tonicai/tonic-fabricate-python
The official Fabricate client package for Python.
https://github.com/tonicai/tonic-fabricate-python
Last synced: 2 months ago
JSON representation
The official Fabricate client package for Python.
- Host: GitHub
- URL: https://github.com/tonicai/tonic-fabricate-python
- Owner: TonicAI
- Created: 2025-08-28T08:43:18.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-01-23T15:15:10.000Z (5 months ago)
- Last Synced: 2026-01-24T06:32:51.371Z (5 months ago)
- Language: Python
- Size: 23.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fabricate Client
The official [Fabricate](https://www.tonic.ai/products/fabricate) client package for Python.
## Installation
```bash
pip install tonic-fabricate
```
## Usage
To generate and download data from Fabricate:
```python
from tonic_fabricate import generate
generate(
# The workspace to use
workspace='Default',
# The name of the database to generate
database='ecommerce',
# The format to generate. Should be one of:
# - 'sql'
# - 'sqlite'
# - 'csv'
# - 'jsonl'
# - 'xml'
format='sql',
# The destination to save the data
dest='./data',
# Optional: Overwrite the destination if it exists
overwrite=True,
# Optional: Generate a single table
# entity='Customers',
)
```
To push data to an existing database:
```python
from tonic_fabricate import generate
import os
generate(
# The workspace to use
workspace='Default',
# The name of the database in Fabricate
database='ecommerce',
# The connection details for the target database
connection={
# The host of the target database
'host': 'host.example.com',
# The port of the target database
'port': 5432,
# The name of the target database
'database_name': 'ecommerce',
# The username for the target database
'username': os.environ.get('FABRICATE_DATABASE_USERNAME'),
# The password for the target database
'password': os.environ.get('FABRICATE_DATABASE_PASSWORD'),
# Whether to use TLS for the connection
'tls': True,
},
)
```
## Progress Tracking
You can track the progress of data generation using a callback function:
```python
from tonic_fabricate import generate
def on_progress(data):
phase = data.get('phase', '')
percent = data.get('percentComplete', 0)
status = data.get('status', '')
phase_text = f"[{phase}] " if phase else ""
status_text = f", {status}" if status else ""
print(f"{phase_text}{percent}% complete{status_text}...")
generate(
workspace='Default',
database='ecommerce',
format='sql',
dest='./data',
on_progress=on_progress
)
```
## Environment Variables
The client will automatically use the following environment variables if they are set:
- `FABRICATE_API_KEY`: Your Fabricate API key
- `FABRICATE_API_URL`: The Fabricate API URL (defaults to https://fabricate.tonic.ai/api/v1)
## Error Handling
The client raises appropriate exceptions for various error conditions:
```python
from tonic_fabricate import generate
try:
generate(
workspace='Default',
database='ecommerce',
format='sql',
dest='./data'
)
except ValueError as e:
print(f"Invalid parameters: {e}")
except Exception as e:
print(f"Generation failed: {e}")
```