# Schepherd-Client
[](https://pypi.org/project/shepherd_client)
[](https://pypi.python.org/pypi/shepherd-client)
[](https://github.com/nes-lab/shepherd-webapi/actions/workflows/quality_assurance.yaml)
**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:
```Shell
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:
```shell
uv pip install git+https://github.com/nes-lab/shepherd-webapi.git@main
```
### Usage
The current interface is introduced in 5 short examples in the example-directory.
Raw data
{
"_id": null,
"home_page": null,
"name": "shepherd-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Ingmar Splitt <ingmar.splitt@tu-dresden.de>",
"keywords": "testbed, beaglebone, pru, batteryless, energyharvesting, solar",
"author": null,
"author_email": "Ingmar Splitt <ingmar.splitt@tu-dresden.de>",
"download_url": "https://files.pythonhosted.org/packages/0c/00/211de8fd2f85028b0afac57b72746888826033ee69d41e355d53c20041c1/shepherd_client-2025.8.2.tar.gz",
"platform": "unix",
"description": "# Schepherd-Client\n\n[](https://pypi.org/project/shepherd_client)\n[](https://pypi.python.org/pypi/shepherd-client)\n[](https://github.com/nes-lab/shepherd-webapi/actions/workflows/quality_assurance.yaml)\n\n**Shepherd Nova Testbed**: https://testbed.nes-lab.org/\n\n**Testbed-WebAPI**: <https://shepherd.cfaed.tu-dresden.de:8000>\n\n**Source Code**: <https://github.com/nes-lab/shepherd-webapi>\n\n**Main Project**: <https://github.com/nes-lab/shepherd>\n\n---\n\nThe Testbed-Client links the user to the testbed.\nIt's written in Python and uses http-requests to communicate with the web-API.\nAs the source is open, you can modify and extend it as you like.\nYou could also write your own tools based on these few hundred lines of code.\n\n## Features\n\n- register & delete an account\n- query user information\n- create, schedule, query state of experiments\n- download results\n\nIn the near future, the functionality will be extended to:\n\n- list content like available energy environments, firmwares, virtual power sources (currently hardcoded in shepherd-core)\n- query the testbed data-model (currently hardcoded in shepherd-core)\n- query state of the observers (last seen alive)\n- query statistics on the scheduler-queue\n- CLI\n\n## Getting started\n\n### Install\n\nYou can install the client by using the package-manager of your choice. In the following example we show pip and uv:\n\n```Shell\npip3 install shepherd-client -U\n# or modern uv with automatic virtual environment\nuv pip install shepherd-client -U\n```\n\nNewest features can be obtained by directly installing from GitHub:\n\n```shell\nuv pip install git+https://github.com/nes-lab/shepherd-webapi.git@main\n```\n\n### Usage\n\nThe current interface is introduced in 5 short examples in the example-directory.\n",
"bugtrack_url": null,
"license": null,
"summary": "Web-Client for the Shepherd-Testbed",
"version": "2025.8.2",
"project_urls": {
"Documentation": "https://github.com/nes-lab/shepherd-webapi/blob/main/README.md",
"Issues": "https://github.com/nes-lab/shepherd-webapi/issues",
"Source": "https://github.com/nes-lab/shepherd-webapi"
},
"split_keywords": [
"testbed",
" beaglebone",
" pru",
" batteryless",
" energyharvesting",
" solar"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7923963c9a5af9cf95fc6676db060a65d78bbbccfd62621e15f77f1c3eea801e",
"md5": "b940175063b53f88b52cfc175ece029d",
"sha256": "d3f34fbbd7d3372b552bcf443ca8e02a4a88eb2f20c486f9ca6c78edf7f90b04"
},
"downloads": -1,
"filename": "shepherd_client-2025.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b940175063b53f88b52cfc175ece029d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 10402,
"upload_time": "2025-08-18T18:58:58",
"upload_time_iso_8601": "2025-08-18T18:58:58.143939Z",
"url": "https://files.pythonhosted.org/packages/79/23/963c9a5af9cf95fc6676db060a65d78bbbccfd62621e15f77f1c3eea801e/shepherd_client-2025.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0c00211de8fd2f85028b0afac57b72746888826033ee69d41e355d53c20041c1",
"md5": "8c92a980d789596c0223464b43478239",
"sha256": "598f979fae840e4975079e8f35f14ab9d20dcfe8985cc3914fd42aa0422a1e19"
},
"downloads": -1,
"filename": "shepherd_client-2025.8.2.tar.gz",
"has_sig": false,
"md5_digest": "8c92a980d789596c0223464b43478239",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10091,
"upload_time": "2025-08-18T18:58:59",
"upload_time_iso_8601": "2025-08-18T18:58:59.075526Z",
"url": "https://files.pythonhosted.org/packages/0c/00/211de8fd2f85028b0afac57b72746888826033ee69d41e355d53c20041c1/shepherd_client-2025.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-18 18:58:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nes-lab",
"github_project": "shepherd-webapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shepherd-client"
}
JSON
