[![CI](https://github.com/vallen-systems/shmdash/workflows/CI/badge.svg)](https://github.com/vallen-systems/shmdash/actions)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI](https://img.shields.io/pypi/v/shmdash)](https://pypi.org/project/shmdash)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/shmdash)](https://pypi.org/project/shmdash)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)
# SHMdash
Python client library to upload data to a SHM Dashboard server.
Have a look at the [basic example](examples/basic.py) for usage.
Further descriptions of the client functions can be found in the docstrings.
> [!NOTE]
> The SHM Dashboard is a product from Vallen Systeme to upload data from different sources and locations and instantly access and visualize the data in a dashboard.
> If you are interested, please check out our [demo dashboard](https://demo.shmdash.de) and contact our sales department [sales@vallen.de](mailto:sales@vallen.de).
## Installation
Install the latest version from [PyPI](https://pypi.org/project/shmdash):
```sh
$ pip install shmdash
```
## Development setup
```sh
# Clone repository
$ git clone https://github.com/vallen-systems/shmdash
$ cd shmdash
# Install package and development tools
$ pip install -e .[dev]
# Run checks
$ ruff check .
$ mypy .
# Run tests
$ pytest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "shmdash",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "client, dashboard, shmdash, upload, vallen",
"author": null,
"author_email": "\"Lukas Berbuer (Vallen Systeme GmbH)\" <lukas.berbuer@vallen.de>",
"download_url": "https://files.pythonhosted.org/packages/84/31/e4f40e481969af99675ff4d328228fb5b8bf2aaed4b3c34665c2aa93efc2/shmdash-0.6.0.tar.gz",
"platform": null,
"description": "[![CI](https://github.com/vallen-systems/shmdash/workflows/CI/badge.svg)](https://github.com/vallen-systems/shmdash/actions)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![PyPI](https://img.shields.io/pypi/v/shmdash)](https://pypi.org/project/shmdash)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/shmdash)](https://pypi.org/project/shmdash)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)\n\n# SHMdash\n\nPython client library to upload data to a SHM Dashboard server.\n\nHave a look at the [basic example](examples/basic.py) for usage.\nFurther descriptions of the client functions can be found in the docstrings.\n\n> [!NOTE]\n> The SHM Dashboard is a product from Vallen Systeme to upload data from different sources and locations and instantly access and visualize the data in a dashboard.\n> If you are interested, please check out our [demo dashboard](https://demo.shmdash.de) and contact our sales department [sales@vallen.de](mailto:sales@vallen.de).\n\n## Installation\n\nInstall the latest version from [PyPI](https://pypi.org/project/shmdash):\n\n```sh\n$ pip install shmdash\n```\n\n## Development setup\n\n```sh\n# Clone repository\n$ git clone https://github.com/vallen-systems/shmdash\n$ cd shmdash\n\n# Install package and development tools\n$ pip install -e .[dev]\n\n# Run checks\n$ ruff check .\n$ mypy .\n\n# Run tests\n$ pytest\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Vallen Systeme Dashboard (SHM Dash) upload client",
"version": "0.6.0",
"project_urls": {
"Issues": "https://github.com/vallen-systems/pySHMdash/issues",
"Source": "https://github.com/vallen-systems/pySHMdash"
},
"split_keywords": [
"client",
" dashboard",
" shmdash",
" upload",
" vallen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6bcb219e9ca7c8f94d0d89e056bb8bde8d7fd6326e4b5be199329cdc12d09d6",
"md5": "bf21dd0416645a9e77f0039e9be51fb6",
"sha256": "b02b6e9345c01ad11ad40e292ffa2834953187d5e63c17307733dcd024cc9339"
},
"downloads": -1,
"filename": "shmdash-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf21dd0416645a9e77f0039e9be51fb6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10025,
"upload_time": "2024-09-16T14:04:00",
"upload_time_iso_8601": "2024-09-16T14:04:00.661654Z",
"url": "https://files.pythonhosted.org/packages/d6/bc/b219e9ca7c8f94d0d89e056bb8bde8d7fd6326e4b5be199329cdc12d09d6/shmdash-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8431e4f40e481969af99675ff4d328228fb5b8bf2aaed4b3c34665c2aa93efc2",
"md5": "2ffea7b64f23c6935e205087675d37c4",
"sha256": "1b584c48639e87438e779d2f124d8d94e4adb83a60ce093e45331a990152f214"
},
"downloads": -1,
"filename": "shmdash-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "2ffea7b64f23c6935e205087675d37c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14156,
"upload_time": "2024-09-16T14:04:02",
"upload_time_iso_8601": "2024-09-16T14:04:02.228697Z",
"url": "https://files.pythonhosted.org/packages/84/31/e4f40e481969af99675ff4d328228fb5b8bf2aaed4b3c34665c2aa93efc2/shmdash-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 14:04:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vallen-systems",
"github_project": "pySHMdash",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shmdash"
}