# tsdf
| Badges | |
|:----:|----|
| **Packages and Releases** | [](https://github.com/biomarkersparkinson/tsdf/releases/latest) [](https://pypi.python.org/pypi/tsdf/) [](https://research-software-directory.org/software/tsdf) |
| **Build Status** | [](https://www.python.org/downloads/)  |
| **DOI** | [](https://doi.org/10.5281/zenodo.7867899) |
| **License** | [](https://github.com/biomarkersparkinson/tsdf/blob/main/LICENSE) |
| **Fairness** | [](https://fair-software.eu) [](https://www.bestpractices.dev/projects/8083) |
A package ([documentation](https://biomarkersparkinson.github.io/tsdf/)) to load TSDF data ([specification](https://arxiv.org/abs/2211.11294)) into Python.
## Installation
### Using `pip`
The package is available in PyPi and requires [Python 3.9](https://www.python.org/downloads/) or higher. It can be installed using:
```bash
$ pip install tsdf
```
## Usage
See our [extended tutorials](https://biomarkersparkinson.github.io/tsdf/).
## Development
### Running tests
```bash
poetry install
poetry run pytest
```
### Building the documentation
We use [mkdocs](https://www.mkdocs.org/) to build the documentation. If you want to build the documentation locally, the following commands will prove useful:
```bash
mkdocs build # build the documentation
mkdocs serve # serve the documentation on a local server
mkdocs gh-deploy # deploy the documentation to GitHub pages
```
## Contributing
Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
## License
This package was created by Pablo RodrÃguez, Peter Kok and Vedran Kasalica. It is licensed under the terms of the Apache License 2.0 license.
## Credits
- The [TSDF data format](https://arxiv.org/abs/2211.11294) was created by Kasper Claes, Valentina Ticcinelli, Reham Badawy, Yordan P. Raykov, Luc J.W. Evers, Max A. Little.
- This package was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
Raw data
{
"_id": null,
"home_page": "https://github.com/biomarkersParkinson/tsdf",
"name": "tsdf",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "Time Series Data Format (TSDF),binary data,digital sensors",
"author": "Peter Kok",
"author_email": "p.kok@esciencecenter.nl",
"download_url": "https://files.pythonhosted.org/packages/82/16/c9a52b5d9f946eca0868e823cc66de197fc2421ed9b1542b2c5acde19eae/tsdf-0.5.2.tar.gz",
"platform": null,
"description": "\n# tsdf\n\n| Badges | |\n|:----:|----|\n| **Packages and Releases** | [](https://github.com/biomarkersparkinson/tsdf/releases/latest) [](https://pypi.python.org/pypi/tsdf/) [](https://research-software-directory.org/software/tsdf) |\n| **Build Status** | [](https://www.python.org/downloads/)  |\n| **DOI** | [](https://doi.org/10.5281/zenodo.7867899) |\n| **License** | [](https://github.com/biomarkersparkinson/tsdf/blob/main/LICENSE) |\n| **Fairness** | [](https://fair-software.eu) [](https://www.bestpractices.dev/projects/8083) |\n\n\n\nA package ([documentation](https://biomarkersparkinson.github.io/tsdf/)) to load TSDF data ([specification](https://arxiv.org/abs/2211.11294)) into Python.\n\n## Installation\n\n### Using `pip`\n\nThe package is available in PyPi and requires [Python 3.9](https://www.python.org/downloads/) or higher. It can be installed using:\n\n```bash\n$ pip install tsdf\n```\n\n## Usage\n\nSee our [extended tutorials](https://biomarkersparkinson.github.io/tsdf/).\n\n## Development\n\n### Running tests\n\n```bash\npoetry install\npoetry run pytest\n```\n\n### Building the documentation\n\nWe use [mkdocs](https://www.mkdocs.org/) to build the documentation. If you want to build the documentation locally, the following commands will prove useful:\n\n```bash\nmkdocs build # build the documentation\nmkdocs serve # serve the documentation on a local server\nmkdocs gh-deploy # deploy the documentation to GitHub pages\n```\n\n## Contributing\n\nInterested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.\n\n## License\n\nThis package was created by Pablo Rodr\u00edguez, Peter Kok and Vedran Kasalica. It is licensed under the terms of the Apache License 2.0 license.\n\n## Credits\n\n- The [TSDF data format](https://arxiv.org/abs/2211.11294) was created by Kasper Claes, Valentina Ticcinelli, Reham Badawy, Yordan P. Raykov, Luc J.W. Evers, Max A. Little.\n- This package was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Python library that provides methods for encoding and decoding TSDF (Time Series Data Format) data, which allows you to easily create, manipulate and serialize TSDF files in your Python code.",
"version": "0.5.2",
"project_urls": {
"Homepage": "https://github.com/biomarkersParkinson/tsdf",
"Repository": "https://github.com/biomarkersParkinson/tsdf"
},
"split_keywords": [
"time series data format (tsdf)",
"binary data",
"digital sensors"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5adafd010401c467a1cf5fbb5ffe8d71511b57d5d80ef2be98e57e35f1f217c9",
"md5": "8c081fb8b5f487bf5a056fefbbe99741",
"sha256": "7bf39836a0bf971a0253532c5af43a2ed34e1cf6b23d7aa05b392bb69b07e0e7"
},
"downloads": -1,
"filename": "tsdf-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8c081fb8b5f487bf5a056fefbbe99741",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 19943,
"upload_time": "2024-02-10T12:04:09",
"upload_time_iso_8601": "2024-02-10T12:04:09.344845Z",
"url": "https://files.pythonhosted.org/packages/5a/da/fd010401c467a1cf5fbb5ffe8d71511b57d5d80ef2be98e57e35f1f217c9/tsdf-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8216c9a52b5d9f946eca0868e823cc66de197fc2421ed9b1542b2c5acde19eae",
"md5": "b85c800a37fd178332588b9377dca53a",
"sha256": "39cfa8b2228dece926c544541882f2d410669936f6b3cb4d5472248c9715cf86"
},
"downloads": -1,
"filename": "tsdf-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "b85c800a37fd178332588b9377dca53a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 16930,
"upload_time": "2024-02-10T12:04:11",
"upload_time_iso_8601": "2024-02-10T12:04:11.051764Z",
"url": "https://files.pythonhosted.org/packages/82/16/c9a52b5d9f946eca0868e823cc66de197fc2421ed9b1542b2c5acde19eae/tsdf-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-10 12:04:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "biomarkersParkinson",
"github_project": "tsdf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tsdf"
}
JSON
