# Shepherd-Herd
[![PyPiVersion](https://img.shields.io/pypi/v/shepherd_herd.svg)](https://pypi.org/project/shepherd_herd)
[![CodeStyle](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
**Main Documentation**: <https://orgua.github.io/shepherd/tools/herd>
**Main Project**: <https://github.com/orgua/shepherd>
**Source Code**: <https://github.com/orgua/shepherd/tree/main/software/shepherd_herd>
---
`Shepherd-herd` is the command line utility for controlling a group of shepherd observers remotely through an IP-based network.
This is the key user interface for a private shepherd instance in the same network.
The python package must be installed on the user's local machine and sends commands to the sheep via *ssh*.
## Installation
`shepherd-herd` is a python package and available on [PyPI](https://pypi.org/project/shepherd_herd).
Use your python package manager to install it.
For example, using pip:
```Shell
pip3 install shepherd-herd
```
For install directly from GitHub-Sources (here `dev`-branch):
```Shell
pip install git+https://github.com/orgua/shepherd.git@dev#subdirectory=software/shepherd-herd -U
```
For install from local sources:
```Shell
cd shepherd/software/shepherd-herd/
pip3 install . -U
```
## Usage
For details either use the help provided by the tool or have a look into the [documentation](https://orgua.github.io/shepherd/tools/herd)
## Library-Examples
See [example-files](https://github.com/orgua/shepherd/tree/main/software/shepherd-herd/examples/) for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "shepherd-herd",
"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": "Kai Geissdoerfer <kai.geissdoerfer@tu-dresden.de>, Ingmar Splitt <ingmar.splitt@tu-dresden.de>",
"download_url": "https://files.pythonhosted.org/packages/93/cf/e8af8d065c7c9841e60fa5f1cd43a72305852e7a42e5676ac6703448b53c/shepherd_herd-0.8.0.tar.gz",
"platform": "unix",
"description": "# Shepherd-Herd\n\n[![PyPiVersion](https://img.shields.io/pypi/v/shepherd_herd.svg)](https://pypi.org/project/shepherd_herd)\n[![CodeStyle](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n\n**Main Documentation**: <https://orgua.github.io/shepherd/tools/herd>\n\n**Main Project**: <https://github.com/orgua/shepherd>\n\n**Source Code**: <https://github.com/orgua/shepherd/tree/main/software/shepherd_herd>\n\n---\n\n`Shepherd-herd` is the command line utility for controlling a group of shepherd observers remotely through an IP-based network.\nThis is the key user interface for a private shepherd instance in the same network.\nThe python package must be installed on the user's local machine and sends commands to the sheep via *ssh*.\n\n## Installation\n\n`shepherd-herd` is a python package and available on [PyPI](https://pypi.org/project/shepherd_herd).\nUse your python package manager to install it.\nFor example, using pip:\n\n```Shell\npip3 install shepherd-herd\n```\n\nFor install directly from GitHub-Sources (here `dev`-branch):\n\n```Shell\npip install git+https://github.com/orgua/shepherd.git@dev#subdirectory=software/shepherd-herd -U\n```\n\nFor install from local sources:\n\n```Shell\ncd shepherd/software/shepherd-herd/\npip3 install . -U\n```\n\n## Usage\n\nFor details either use the help provided by the tool or have a look into the [documentation](https://orgua.github.io/shepherd/tools/herd)\n\n## Library-Examples\n\nSee [example-files](https://github.com/orgua/shepherd/tree/main/software/shepherd-herd/examples/) for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Synchronized Energy Harvesting Emulator and Recorder CLI",
"version": "0.8.0",
"project_urls": {
"Documentation": "https://orgua.github.io/shepherd",
"Homepage": "https://pypi.org/project/shepherd-herd",
"Issues": "https://github.com/orgua/shepherd/issues",
"Source": "https://github.com/orgua/shepherd"
},
"split_keywords": [
"testbed",
" beaglebone",
" pru",
" batteryless",
" energyharvesting",
" solar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3da6a8cdb82b46f3be6db747ded7cfd373ba4a1e43ad03515e5fc06ba199842",
"md5": "79d94bc2c96c8053946c3bfaf82588f0",
"sha256": "b59381282b7d5c84e5391fcb47ed2f8a424cbc2a28af5fd90c8249ccf75cb13f"
},
"downloads": -1,
"filename": "shepherd_herd-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79d94bc2c96c8053946c3bfaf82588f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 20273,
"upload_time": "2024-07-09T09:43:55",
"upload_time_iso_8601": "2024-07-09T09:43:55.692417Z",
"url": "https://files.pythonhosted.org/packages/c3/da/6a8cdb82b46f3be6db747ded7cfd373ba4a1e43ad03515e5fc06ba199842/shepherd_herd-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93cfe8af8d065c7c9841e60fa5f1cd43a72305852e7a42e5676ac6703448b53c",
"md5": "75c129075c559c9c93d05b06f6276181",
"sha256": "f059fb27bb78ad4d25a9d39d7561ea3c86458153973d7fbfc8e59d93830202f1"
},
"downloads": -1,
"filename": "shepherd_herd-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "75c129075c559c9c93d05b06f6276181",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 18197,
"upload_time": "2024-07-09T09:43:57",
"upload_time_iso_8601": "2024-07-09T09:43:57.088641Z",
"url": "https://files.pythonhosted.org/packages/93/cf/e8af8d065c7c9841e60fa5f1cd43a72305852e7a42e5676ac6703448b53c/shepherd_herd-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 09:43:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "orgua",
"github_project": "shepherd",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shepherd-herd"
}