t4

T4 API

config(*catalog_url, **config_values)

Set or read the T4 configuration.

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

    >>> import t4
    >>> t4.config()

To trigger autoconfiguration, call with just the navigator URL:

    >>> t4.config('https://example.com')

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

    >>> t4.config(navigator_url='http://example.com',
    ...           elastic_search_url='http://example.com/queries')

Default config values can be found in t4.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

T4Config: (an ordered Mapping)

delete_package(name, registry=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

list_packages(registry=None)

Lists Packages in the registry.

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

Arguments

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

Returns

A list of strings containing the names of the packages

Last updated