dockerreg.api package¶

Submodules¶

dockerreg.api.v1 module¶

class dockerreg.api.v1.ApiClientV1(host, url_prefix=None, username=None, auth=None, auth_url=None, verify=True, cert=None, cache=None, **kwargs)[source]¶

Bases: dockerreg.api.BaseApiClient, dockerreg.api.v1.RegistryV1Mixin, dockerreg.api.v1.RepositoryV1Mixin

__init__(host, url_prefix=None, username=None, auth=None, auth_url=None, verify=True, cert=None, cache=None, **kwargs)[source]¶

registry()[source]¶

class dockerreg.api.v1.RegistryV1Mixin[source]¶

Bases: object

ping()[source]¶

search(q, n=25, page=1)[source]¶

class dockerreg.api.v1.RepositoryV1Mixin[source]¶

Bases: object

delete_repository(repository)[source]¶

delete_tag(repository, tag)[source]¶

get_ancestry(image_id)[source]¶

get_image(image_id, raw=False)[source]¶

get_image_id(repository, tag)[source]¶

get_layer(image_id)[source]¶

get_tags(repository)[source]¶

put_image(image_id, metadata)[source]¶

put_layer(image_id, data)[source]¶

set_tag(repository, tag, image_id)[source]¶

dockerreg.api.v2 module¶

class dockerreg.api.v2.ApiClientV2(host, url_prefix=None, username=None, auth=None, auth_url=None, verify=True, cert=None, cache=None, **kwargs)[source]¶

Bases: dockerreg.api.BaseApiClient, dockerreg.api.v2.RegistryV2Mixin, dockerreg.api.v2.RepositoryV2Mixin

__init__(host, url_prefix=None, username=None, auth=None, auth_url=None, verify=True, cert=None, cache=None, **kwargs)[source]¶

registry()[source]¶

class dockerreg.api.v2.RegistryV2Mixin[source]¶

Bases: object

get_repositories()[source]¶

class dockerreg.api.v2.RepositoryV2Mixin[source]¶

Bases: object

delete_blob(repository, digest, raw=False)[source]¶

delete_manifest(repository, reference, raw=False)[source]¶

delete_manifest_by_tag(repository, tag, raw=False)[source]¶

get_blob(repository, digest, raw=False)[source]¶

get_blob_size(repository, digest)[source]¶

get_manifest(repository, reference, raw=False)[source]¶

get_reference_metadata(repository, reference, raw=False)[source]¶

get_tags(repository, raw=False)[source]¶

post_blob(repository, digest, data, raw=False)[source]¶

put_manifest(repository, reference, manifest, media_type=None)[source]¶

Module contents¶

class dockerreg.api.BaseApiClient(host, url_prefix=None, username=None, auth=None, auth_url=None, cache=None, verify=True, cert=None, key=None, version=None, source_address=None, **kwargs)[source]¶

Bases: object

A class providing access to the low-level Docker Registry API.

__init__(host, url_prefix=None, username=None, auth=None, auth_url=None, cache=None, verify=True, cert=None, key=None, version=None, source_address=None, **kwargs)[source]¶

Parameters:	(str) (url_prefix) – the FQDN of the registry host, possibly postfixed by :port. (str) –

apiurl¶

authping()[source]¶

baseurl¶

delete(suburl, **kwargs)[source]¶

get(suburl, **kwargs)[source]¶

get_cached_auth(fields)[source]¶

head(suburl, **kwargs)[source]¶

host¶

patch(suburl, **kwargs)[source]¶

ping()[source]¶

post(suburl, **kwargs)[source]¶

put(suburl, **kwargs)[source]¶

registry()[source]¶

Returns:	a dockerreg.models.BaseRegistry corresponding to this dockerreg.api.BaseApiClient.

version¶

class dockerreg.api.SourceAddressAdapter(source_address, **kwargs)[source]¶

Bases: requests.adapters.HTTPAdapter

__init__(source_address, **kwargs)[source]¶

init_poolmanager(connections, maxsize, block=False)[source]¶