Skip to main content

Shepherd-Client

PyPIVersion PyVers QA-Tests

Shepherd Nova Testbed: https://testbed.nes-lab.org/

Testbed-WebAPI: https://shepherd.cfaed.tu-dresden.de:8000

Source Code: https://github.com/nes-lab/shepherd-webapi

Main Project: https://github.com/nes-lab/shepherd


The Testbed-Client links the user to the testbed. It's written in Python and uses http-requests to communicate with the web-API. As the source is open, you can modify and extend it as you like. You could also write your own tools based on these few hundred lines of code.

Features

  • register & delete an account
  • query user information
  • create, schedule, query state of experiments
  • download results

In the near future, the functionality will be extended to:

  • list content like available energy environments, firmwares, virtual power sources (currently hardcoded in shepherd-core)
  • query the testbed data-model (currently hardcoded in shepherd-core)
  • query state of the observers (last seen alive)
  • query statistics on the scheduler-queue
  • CLI

Getting started

Install

You can install the client by using the package-manager of your choice. In the following example we show pip and uv:

pip3 install shepherd-client -U
# or modern uv with automatic virtual environment
uv pip install shepherd-client -U

Newest features can be obtained by directly installing from GitHub:

uv pip install git+https://github.com/nes-lab/shepherd-webapi.git@main#subdirectory=shepherd_client

Usage

The current interface is introduced in 5 short examples in the example-directory.

Metadata

Release files for shepherd-client 2026.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shepherd-client 2026.10.1
File Size Uploaded
shepherd_client-2026.10.1.tar.gz 10.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for shepherd-client 2026.10.1
File Interpreter ABI Platform
shepherd_client-2026.10.1-py3-none-any.whl Python 3 none any Details

Total release size: 22.0 kB

Release files / shepherd_client-2026.10.1.tar.gz

Download URL shepherd_client-2026.10.1.tar.gz
Size 10.0 kB
Tags Source
SHA-256 checksum
How to use checksums
afda6900ee16f51fb8b5b63e3863488590f82a2bf891581cc8299a0b0697e93a
BLAKE2b-256 checksum
How to use checksums
0ae45bd4977cfb650f4ca1f001a18d5780924b831d7e1bb182913841cae51bbf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 14, 2026.

Transparency log

Release files / shepherd_client-2026.10.1-py3-none-any.whl

Download URL shepherd_client-2026.10.1-py3-none-any.whl
Size 12.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2853dbd5d66da51150ce1bbba19d1bbd6b6ef552e3e39cda05ac119a0082e00d
BLAKE2b-256 checksum
How to use checksums
6a1a06e2bbad1bbd71b020d6e50ebb312acdf00711feebd42b7072a997cc011c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 14, 2026.

Transparency log
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page