Skip to content

porestore.client

Authenticated access to the public v1 API.

Client

A service/team connection. Storage transfers use a separate, uncredentialed client.

Missing values are read from PORESTORE_API_KEY, PORESTORE_TEAM_ID and PORESTORE_URL in the environment, then .env in the current working directory. Explicit arguments take precedence. No request is made until an operation is called, and .env values do not modify the environment.

base_url = base_url instance-attribute

team_id = team_id instance-attribute

cache_dir = Path(cache_dir or Path.home() / '.cache' / 'porestore').expanduser() instance-attribute

close()

get_image(image_id)

get_job(job_id)

analysis_types()

Return available analyses and their current parameter schemas.

resource_id(value) -> str

Normalize a public resource ID without allowing path components.

configure(**kwargs)

Configure the default connection from arguments, the environment, and cwd/.env.

get_client(client=None)