quilt3

Quilt API

config(*catalog_url, **config_values)

Set or read the QUILT configuration.

To retrieve the current config, call directly, without arguments:

import quilt3
quilt3.config()

To trigger autoconfiguration, call with just the navigator URL:

import quilt3
quilt3.config('https://YOUR-CATALOG-URL.com')

To set config values, call with one or more key=value pairs:

import quilt3
quilt3.config(navigator_url='http://example.com')

Default config values can be found in quilt3.util.CONFIG_TEMPLATE.

Arguments

• catalog_url: A (single) URL indicating a location to configure from

• **config_values: key=value pairs to set in the config

Returns

QuiltConfig: (an ordered Mapping)

delete_package(name, registry=None, top_hash=None)

Delete a package. Deletes only the manifest entries and not the underlying files.

Arguments

• name (str): Name of the package

• registry (str): The registry the package will be removed from

• top_hash (str): Optional. A package hash to delete, instead of the whole package.

get_boto3_session(*, fallback: bool = True) -> boto3.session.Session

Return a Boto3 session with Quilt stack credentials and AWS region. In case of no Quilt credentials found, return a "normal" Boto3 session if fallback is True, otherwise raise a QuiltException.

Note: you need to call quilt3.config("https://your-catalog-homepage/") to have region set on the session, if you previously called it in quilt3 < 6.1.0.

list_package_versions(name, registry=None)

Lists versions of a given package.

Returns an iterable of (latest_or_unix_ts, hash) of package revisions. If the registry is None, default to the local registry.

Arguments

• name (str): Name of the package

• registry (str): location of registry to load package from.

Returns

An iterable of tuples containing the version and hash for the package.

list_packages(registry=None)

Lists Packages in the registry.

Returns an iterable of all named packages in a registry. If the registry is None, default to the local registry.

Arguments

• registry (str): location of registry to load package from.

Returns

An iterable of strings containing the names of the packages

logged_in()

Return catalog URL if Quilt client is authenticated. Otherwise return None.

login()

Authenticate to your Quilt stack and assume the role assigned to you by your stack administrator. Not required if you have existing AWS credentials.

Launches a web browser and asks the user for a token.

logout()

Do not use Quilt credentials. Useful if you have existing AWS credentials.

search(query: Union[str, dict], limit: int = 10) -> List[dict]

Execute a search against the configured search endpoint.

Arguments

• query: query string to query if passed as str, DSL query body if passed as dict

• limit: maximum number of results to return. Defaults to 10

Query Syntax: Query String Query Query DSL

Returns

search results