hopsworks #

login #

login(
    host: str | None = None,
    port: int = 443,
    project: str | None = None,
    api_key_value: str | None = None,
    api_key_file: str | None = None,
    hostname_verification: bool = False,
    trust_store_path: str | None = None,
    cert_folder: str | None = None,
    engine: Literal[
        "spark",
        "python",
        "training",
        "spark-no-metastore",
        "spark-delta",
    ]
    | None = None,
) -> project.Project

Connect to Hopsworks SaaS by calling the hopsworks.login() function with no arguments.

Connect to Hopsworks SaaS

import hopsworks

project = hopsworks.login()

Alternatively, connect to your own Hopsworks installation by specifying the host, port and API key.

Connect to your Hopsworks cluster

import hopsworks

project = hopsworks.login(
    host="my.hopsworks.server",
    port=8181,
    api_key_value="DKN8DndwaAjdf98FFNSxwdVKx",
)

In addition to setting function arguments directly, hopsworks.login() also reads the environment variables: HOPSWORKS_HOST, HOPSWORKS_PORT, HOPSWORKS_PROJECT, HOPSWORKS_API_KEY, HOPSWORKS_HOSTNAME_VERIFICATION, HOPSWORKS_TRUST_STORE_PATH, HOPSWORKS_CERT_FOLDER and HOPSWORKS_ENGINE.

The function arguments do however take precedence over the environment variables in case both are set.

PARAMETER	DESCRIPTION
`host`	The hostname of the Hopsworks instance. TYPE: `str \| None` DEFAULT: `None`
`port`	The port on which the Hopsworks instance can be reached. TYPE: `int` DEFAULT: `443`
`project`	Name of the project to access. If used inside a Hopsworks environment it always gets the current project. If not provided you will be prompted to enter it. TYPE: `str \| None` DEFAULT: `None`
`api_key_value`	Value of the API Key. TYPE: `str \| None` DEFAULT: `None`
`api_key_file`	Path to file wih API Key. TYPE: `str \| None` DEFAULT: `None`
`hostname_verification`	Whether to verify Hopsworks' certificate. TYPE: `bool` DEFAULT: `False`
`trust_store_path`	Path on the file system containing the Hopsworks certificates. TYPE: `str \| None` DEFAULT: `None`
`cert_folder`	The directory to store downloaded certificates. Defaults to the system temp directory. TYPE: `str \| None` DEFAULT: `None`
`engine`	Specifies the engine to use. The default value is `None`, which automatically selects the engine based on the environment: `spark`: Used if Spark is available, such as in Hopsworks or Databricks environments. `python`: Used in local Python environments or AWS SageMaker when Spark is not available. `training`: Used when only feature store metadata is needed, such as for obtaining training dataset locations and label information during Hopsworks training experiments. `spark-no-metastore`: Functions like `spark` but does not rely on the Hive metastore. `spark-delta`: Minimizes dependencies further by avoiding both Hive metastore and HopsFS. TYPE: `Literal['spark', 'python', 'training', 'spark-no-metastore', 'spark-delta'] \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`project.Project`	The Project object to perform operations on.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	If the backend encounters an error when handling the request.
`hopsworks.client.exceptions.HopsworksSSLClientError`	If SSLError is raised from underlying requests library.

create_project #

create_project(
    name: str,
    description: str | None = None,
    feature_store_topic: str | None = None,
    namespace: str | None = None,
) -> project.Project | None

Create a new project.

Example for creating a new project

import hopsworks

hopsworks.login(...)

hopsworks.create_project("my_project", description="An example Hopsworks project")

PARAMETER	DESCRIPTION
`name`	The name of the project. TYPE: `str`
`description`	Description of the project. TYPE: `str \| None` DEFAULT: `None`
`feature_store_topic`	Feature store topic name. TYPE: `str \| None` DEFAULT: `None`
`namespace`	Kubernetes namespace to use for the project. If `None` the backend derives one from the project name. TYPE: `str \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`project.Project \| None`	The Project object to perform operations on.

disable_usage_logging #

disable_usage_logging()

Disable anonymous usage logging for this SDK session.

Usage logging is already disabled by default; call this to be explicit or after it has been enabled elsewhere.

get_current_project #

get_current_project() -> project.Project

Get a reference to the current logged in project.

Example for getting the project reference

import hopsworks

hopsworks.login()

project = hopsworks.get_current_project()

RETURNS	DESCRIPTION
`project.Project`	The Project object to perform operations on.

get_env_vars_api #

get_env_vars_api() -> env_var_api.EnvVarsApi

Get the environment variables api.

RETURNS	DESCRIPTION
`env_var_api.EnvVarsApi`	The environment variables API handle.

get_sdk_info #

get_sdk_info() -> str

Return the environment information the SDK reports for usage logging.

RETURNS	DESCRIPTION
`str`	A JSON string describing the SDK and runtime environment.

get_secrets_api #

get_secrets_api() -> secret_api.SecretsApi

Get the secrets api.

RETURNS	DESCRIPTION
`secret_api.SecretsApi`	The Secrets API handle.

get_users_api #

get_users_api() -> users_api.UsersApi

Get the platform users administration api.

This is an admin-only capability; the logged-in account must hold the HOPS_ADMIN platform role for its methods to succeed.

Example

import hopsworks

hopsworks.login()
users_api = hopsworks.get_users_api()

for user in users_api.get_users():
    print(user.email, user.roles)

RETURNS	DESCRIPTION
`users_api.UsersApi`	The Users API handle.

logout #

logout()

Cleans up and closes the connection for hopsworks.