Client Installation Guide#

Hopsworks Python library#

The Hopsworks Python client library is required to connect to Hopsworks from your local machine or any other Python environment such as Google Colab or AWS Sagemaker. Execute the following command to install the Hopsworks client library in your Python environment:

conda install twofish
pip install hopsworks[python]

uv venv && source .venv/bin/activate
uv pip install "hopsworks[python]"

python3 -m venv .venv && source .venv/bin/activate
pip install "hopsworks[python]"

Supported versions of Python: 3.10, 3.11, 3.12, 3.13, 3.14 (PyPI ↗)

Profiles#

The Hopsworks library has several profiles that bring additional dependencies and enable additional functionalities:

You can install all the above profiles with the following command:

uv pip install "hopsworks[python,great-expectations,polars]"

Skills and instructions for coding agents#

The Hopsworks Python library ships a set of skills for coding agents: Claude Code, Codex, GitHub Copilot and OpenCode. Inside a Hopsworks terminal they are available to every agent automatically. On your own machine, two commands make them available in the repository you are working in.

Authenticate and write the agent instructions#

uv pip install "hopsworks[python]"
cd <your-repository>
hops setup --host https://<your-cluster>

Without --host, hops setup asks for the host and proposes https://eu-west.cloud.hopsworks.ai, the Hopsworks serverless endpoint; press Enter to accept it or type the address of your cluster. hops setup opens a browser page where you choose a project, creates an API key for it, and stores the key in ~/.hops.toml. It then writes the following files into the current directory:

AGENTS.md is read by Claude Code, Codex, GitHub Copilot and OpenCode. The files under .claude/ are read by Claude Code only. Running hops setup again in a directory that already has these files updates the files you have not edited and leaves the ones you have edited unchanged. Pass --no-scaffold to authenticate without writing any files.

Add the Hopsworks skills#

hops skills install

hops skills install copies the Hopsworks skills into .claude/skills/, one directory per skill, which is where Claude Code discovers them. For another agent, pass --agent, which can be repeated:

hops skills install --agent codex
hops skills install --agent copilot
hops skills install --agent opencode

The skills are written to .codex/skills/, .agents/skills/ and .opencode/skills/ respectively, and for OpenCode the path is also registered in opencode.json. An agent loads only the name and description of each skill when it starts and reads a skill in full when a task calls for it, so adding all of them costs a few kilobytes of context rather than the size of the skills themselves.

Running hops skills install again after upgrading the hopsworks library updates the skills you have not edited, keeps the skills you have edited, and removes skills that the new version no longer ships. Pass --force to overwrite edited skills as well.

To read the skills without adding them to a repository:

hops skills list
hops skills show hops-fg

Hopsworks Java Library#

If you want to interact with the Hopsworks Feature Store from environments such as Spark or Beam, you can use the Hopsworks Feature Store (Hopsworks) Java library.

The Hopsworks library is available on the Hopsworks' Maven repository. If you are using Maven as build tool, you can add the following in your pom.xml file:

<repositories>
    <repository>
        <id>Hops</id>
        <name>Hops Repository</name>
        <url>https://archiva.hops.works/repository/Hops/</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

The library has different builds targeting different environments:

Hopsworks Java#

The artifactId for the Hopsworks Java build is hsfs, if you are using Maven as build tool, you can add the following dependency:

<dependency>
    <groupId>com.logicalclocks</groupId>
    <artifactId>hsfs</artifactId>
    <version>${hsfs.version}</version>
</dependency>

Spark#

The artifactId for the Spark build is hsfs-spark-spark{spark.version}, if you are using Maven as build tool, you can add the following dependency:

<dependency>
    <groupId>com.logicalclocks</groupId>
    <artifactId>hsfs-spark-spark3.1</artifactId>
    <version>${hsfs.version}</version>
</dependency>

Hopsworks provides builds for Spark 3.1, 3.3 and 3.5. The builds are also provided as JAR files which can be downloaded from Hopsworks repository

Beam#

The artifactId for the Beam build is hsfs-beam, if you are using Maven as build tool, you can add the following dependency:

<dependency>
    <groupId>com.logicalclocks</groupId>
    <artifactId>hsfs-beam</artifactId>
    <version>${hsfs.version}</version>
</dependency>

Next Steps#

If you are using a local python environment and want to connect to Hopsworks, you can follow the Python Guide section to create an API Key and to get started. If you use a coding agent, see Skills and instructions for coding agents to give it the Hopsworks skills.

Other environments#

The Hopsworks Feature Store client libraries can also be installed in external environments, such as Databricks, AWS Sagemaker, or Azure Machine Learning. For more information, see Client Integrations.