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.8.0a2.tar.gz (36.2 kB view details)

Uploaded Source

Built Distribution

gable-0.8.0a2-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

Details for the file gable-0.8.0a2.tar.gz.

File metadata

  • Download URL: gable-0.8.0a2.tar.gz
  • Upload date:
  • Size: 36.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.8.0a2.tar.gz
Algorithm Hash digest
SHA256 662f32d0afe96bccd1580d7493b916388df2f0c4f0a1f380d1a4b03d7b7baddf
MD5 481068606bc21dba9b7025820f03ae72
BLAKE2b-256 24dd5d3c7060b5bdf150a669903820f1cf10f3dce7aa80420837489e0798352c

See more details on using hashes here.

File details

Details for the file gable-0.8.0a2-py3-none-any.whl.

File metadata

  • Download URL: gable-0.8.0a2-py3-none-any.whl
  • Upload date:
  • Size: 43.7 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.8.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 be470f1229afb5903326b0024346950dd737d5776cf47ce0181c305820dc536e
MD5 b5563c0b8fa51b91f1a66e594980ff26
BLAKE2b-256 7df9179c903daa3eed5ef5025de662c6892bb2bc4cd5d0d1c2d474553bf9cf93

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