Gretel Python Client

CLI and Python SDKs for interacting with Gretel's privacy engineering APIs.

Getting Started

The following command will install the latest stable Gretel CLI and Python SDK

pip install gretel-client

To install the latest development version, you may run

pip install git+https://github.com/gretelai/gretel-python-client@main

To configure the CLI, run

gretel configure

System Requirements

The Gretel CLI and python SDKs require Python version 3.9 or greater. Docker is required for local training and generation jobs.

For more information please refer to the Gretel Environment Setup docs.

Client SDKs

The gretel-client package also ships with a set of Python Client SDKs that may be used to interact with Gretel APIs using a familiar pythonic interface. For more information on how to use these SDKs, please refer to the following links

• Projects SDK Reference

Modules

• Gretel CLI
• High-level SDK Interface
  • Interface
  • Job Results
  • Artifact Fetching
• Navigator Inference API
  • Tabular data generation
  • Natural language data generation
• Projects SDK
  • Projects
  • Models
  • Records
  • Docker
  • Exceptions
• Client Config
  • ClientConfig
  • Context
  • DEFAULT_GRETEL_ARTIFACT_ENDPOINT
  • DEFAULT_GRETEL_ENDPOINT
  • DefaultClientConfig
  • DelegatingClientConfig
  • GRETEL
  • GRETEL_API_KEY
  • GRETEL_ARTIFACT_ENDPOINT
  • GRETEL_CONFIG_FILE
  • GRETEL_ENDPOINT
  • GRETEL_PREVIEW_FEATURES
  • GRETEL_PROJECT
  • GRETEL_RUNNER_MODE
  • GRETEL_TENANT_NAME
  • GRETEL_TENANT_UNSET
  • GretelApiRetry
  • GretelClientConfigurationError
  • PreviewFeatures
  • RunnerMode
  • TaggedClientConfig
  • clear_gretel_config()
  • configure_session()
  • get_session_config()
  • write_config()
• Quality Report
  • QualityReport
• Helpers
  • do_api_call()
  • poll()
  • submit_docker_local()
• Google BigQuery Integration
  • BigQuery DataFrames

Indices and tables

• Index

• Module Index

• Search Page