gable 0.17.0b5

Command line interface (CLI) and software development kit (SDK) to interact with Gable API

Gable CLI and SDK

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]'

Setting up zsh/bash Autocomplete

The Gable CLI supports shell autocomplete for zsh and bash so you can hit TAB to see available commands and options as you write the command.

To enable it, run the following commands:

_SHELL=zsh # or bash
GABLE_CONFIG_DIR=~/.config/gable
mkdir -p $GABLE_CONFIG_DIR
_GABLE_COMPLETE=${_SHELL}_source gable > $GABLE_CONFIG_DIR/complete.sh

Then add the following to your shell startup scripts (e.g. .zshrc, .bashrc):

source ~/.config/gable/complete.sh

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

Publishing to PyPi

Full releases should be published in an automated way by the github deployment pipelines. In the event we want to quickly deploy a pre-release to a customer:

1. Update the version in the pyproject.toml file by appending a a0 or b0 (for alpha or beta), so for example 0.3.0a0. The number afterwards can be incremented as needed if you need to publish a new version of the pre-release (a1, a2, etc).
2. Grab the API KEY from the PyPi Gable Login+API Key login in the Engineering 1password vault.
3. Run TWINE_PASSWORD="the value you got from 1password!!!" poetry run poe publish_pypi_pre
4. Verify the new version shows up in our PyPi project history, and is marked as PRE-RELEASE.
5. Open a PR to commit the new version in the pyproject.toml. On merging the automation will fail (gracefully) due to the specified version already existing in pypi