Skip to main content

Command line interface to interact with Gable API

Project description

Gable CLI

gable is Gable on the command line. It publishes contracts, registers data assets and more.

gable --help
Usage: gable [OPTIONS] COMMAND [ARGS]...

Options:
  --endpoint TEXT  Customer API endpoint for Gable, in the format
                   https://api.company.gable.ai/
  --api-key TEXT   API Key for Gable
  --version        Show the version and exit.
  --help           Show this message and exit.

Commands:
  auth        View configured Gable authentication information
  contract    Validate/publish contracts and check data asset compliance
  data-asset  Commands for data assets
  ping        Pings the Gable API to check for connectivity

Getting Started

gable is hosted on PyPi, so to install it just run:

pip install gable

Installing Additional Modules for MySQL and PostgreSQL

Gable's CLI allows you to introspect your database and register tables as data assets within Gable's system. Connecting to these databases require additional packages to communicate with your database(s) of choice.

For MySQL, install the additional packages by running:

pip install 'gable[mysql]'

For PostgreSQL, install the additional packages by running:

pip install 'gable[postgres]'

To install all additional dependencies at once, you can run:

pip install 'gable[all]'

Authentication

To establish an authenticated connection with Gable via the CLI, you need:

  • The API endpoint associated with your organization
  • An API key that corresponds to the endpoint

In order to find your API key and API endpoint, see the documentation in your Gable web app at (/docs/settings/api_keys).

There are two supported methods for providing this config to the CLI:

Authenticating with CLI Arguments

You have the option to pass the endpoint and API key information directly as arguments during the CLI invocation. For example:

gable --endpoint "https://api.yourorganization.gable.ai" --api-key "yourapikey" ping

Authenticating with Environment Variables

To avoid providing this config every time you execute a command, you can set them as environment variables: GABLE_API_ENDPOINT and GABLE_API_KEY. To make them persistent in your environment, add this to your shell initialization file (e.g. .zshrc or .bashrc):

export GABLE_API_ENDPOINT="https://api.yourorganization.gable.ai"
export GABLE_API_KEY="yourapikey"

Then, you can simply use the CLI as follows:

gable ping

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

gable-0.12.1.tar.gz (44.2 kB view details)

Uploaded Source

Built Distribution

gable-0.12.1-py3-none-any.whl (53.9 kB view details)

Uploaded Python 3

File details

Details for the file gable-0.12.1.tar.gz.

File metadata

  • Download URL: gable-0.12.1.tar.gz
  • Upload date:
  • Size: 44.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for gable-0.12.1.tar.gz
Algorithm Hash digest
SHA256 53922e95fc3b66c9af9a94367ae6b26ee29aca5854f4116cca9424fe46134197
MD5 ae79616036605392b29a4a09b22826f9
BLAKE2b-256 aec025efa0a1dacc7f98c8c459a9e49b33911108851d730d7a9974490dd29c81

See more details on using hashes here.

File details

Details for the file gable-0.12.1-py3-none-any.whl.

File metadata

  • Download URL: gable-0.12.1-py3-none-any.whl
  • Upload date:
  • Size: 53.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for gable-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5025fc73e45b52e151b3fa534c877bf6fd485441bf3ff0ffb866e60215a42faf
MD5 4c0b44b6b0d7464b6e88c31442dee3f9
BLAKE2b-256 57d93d0dfec05a80a3b4e20b137d9c8febf8bedf2f0c79f3ba6df37dc0ac0a83

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