[](https://badge.fury.io/py/sdata)
[](https://pypi.python.org/pypi/sdata/)
[](http://sdata.readthedocs.io/en/latest/)
[](https://travis-ci.org/lepy/sdata)
[](https://www.codacy.com/app/lepy/sdata?utm_source=github.com&utm_medium=referral&utm_content=lepy/sdata&utm_campaign=Badge_Grade)
[](https://coveralls.io/github/lepy/sdata?branch=master)
[](https://doi.org/10.5281/zenodo.4311323)
https://lepy.github.io/sdata/
# Structured data format (sdata)
## Design goals
* open data format for open science projects
* self describing data
* flexible data structure layout
* hierarchical data structure (nesting groups, dictionaries)
* (posix path syntax support?)
* extendable data structure
* data format versions
* platform independent
* simple object model
* support of standard metadata formats (key/value, ...)
* support of standard dataset formats (hdf5, netcdf, csv, ...)
* support of standard dataset types (datacubes, tables, series, ...)
* support of physical units (conversion of units)
* transparent, optional data compression (zlib, blosc, ...)
* support of (de-)serialization of every dataset type (group, data, metadata)
* easy defineable (project) standards, e.g. for a uniaxial tension test (UT)
* (optional data encryption (gpg, ...))
* change management support?
* Enable use of data structures from existing tensor libraries transparently
* (single writer/ multiple reader (swmr) support)
* (nested data support)
```
df = pandas.DataFrame({"a":[1,2,3]})
import sdata
data = sdata.Data(name="my_data", table=df, comment="A remarkable comment")
data.metadata.add("my_key", 123, unit="m^3", description="a volume")
data.metadata.add("force", 1.234, unit="kN", description="x force")
data.to_xlsx(filepath="my_data.xlsx")
print(data.metadata.df)
```
```
name value dtype unit description
key
name name my_data str -
uuid uuid 08222ca66e5047808bdc3b35d8f17224 str -
my_key my_key 123 int m^3 a volume
force force 1.234 float kN x force
```
## Howto
* [Das sdata-Format - slides](https://lepy.github.io/sdata/ipynb/Das_sdata_Format.slides.html#)
## Demo App
* [test the demo app with editor](https://share.streamlit.io/lepy/sdata_streamlit/main/sdata_editor.py)
Try to paste some Excel-Data in the forms ...
## Metadata
### Attributes
* name
* value
* dtype
* unit
* description
* label
* required
### dtypes for attributes
* int
* float
* str
* bool
* timestamp (datetime.isoformat with timezone)
## paper
* [Das sdata-Format](https://zenodo.org/record/4311323#.X89yo9-YXys)
* Ingolf Lepenies. (2020). Das sdata-Format (Version 0.8.4). http://doi.org/10.5281/zenodo.4311323
* [slides](https://lepy.github.io/sdata/ipynb/Das_sdata_Format.slides.html#),
[html](https://lepy.github.io/sdata/paper/2020/Das_sdata-Format.html),
[pdf](https://lepy.github.io/sdata/paper/2020/Das_sdata-Format.pdf)
[temperaturmessung-001.json](https://lepy.github.io/sdata/paper/2020/temperaturmessung-001.json)
[temperaturmessung-001.xlsx](https://lepy.github.io/sdata/paper/2020/temperaturmessung-001.xlsx)
* [sdata](https://doi.org/10.5281/zenodo.4311396)
* Ingolf Lepenies. (2020, December 8). sdata - a structured data format (Version 0.8.4). Zenodo. http://doi.org/10.5281/zenodo.4311397
Raw data
{
"_id": null,
"home_page": "https://github.com/lepy/sdata",
"name": "sdata",
"maintainer": "Lepy",
"docs_url": "https://pythonhosted.org/sdata/",
"requires_python": null,
"maintainer_email": "lepy@tuta.io",
"keywords": "open data",
"author": "Lepy",
"author_email": "lepy@tuta.io",
"download_url": "https://files.pythonhosted.org/packages/fc/41/105a9143e8927a6ca7f61d4b160003e226efb96310c96364b78fbf4efa45/sdata-0.23.2.tar.gz",
"platform": null,
"description": "\n[](https://badge.fury.io/py/sdata)\n[](https://pypi.python.org/pypi/sdata/)\n[](http://sdata.readthedocs.io/en/latest/) \n[](https://travis-ci.org/lepy/sdata)\n[](https://www.codacy.com/app/lepy/sdata?utm_source=github.com&utm_medium=referral&utm_content=lepy/sdata&utm_campaign=Badge_Grade)\n[](https://coveralls.io/github/lepy/sdata?branch=master)\n[](https://doi.org/10.5281/zenodo.4311323)\n\nhttps://lepy.github.io/sdata/\n\n# Structured data format (sdata)\n\n## Design goals\n\n* open data format for open science projects\n* self describing data\n* flexible data structure layout\n * hierarchical data structure (nesting groups, dictionaries)\n * (posix path syntax support?)\n* extendable data structure\n * data format versions\n* platform independent\n* simple object model\n* support of standard metadata formats (key/value, ...)\n* support of standard dataset formats (hdf5, netcdf, csv, ...)\n* support of standard dataset types (datacubes, tables, series, ...)\n* support of physical units (conversion of units)\n* transparent, optional data compression (zlib, blosc, ...)\n* support of (de-)serialization of every dataset type (group, data, metadata)\n* easy defineable (project) standards, e.g. for a uniaxial tension test (UT)\n* (optional data encryption (gpg, ...))\n* change management support?\n* Enable use of data structures from existing tensor libraries transparently\n* (single writer/ multiple reader (swmr) support)\n* (nested data support)\n\n```\ndf = pandas.DataFrame({\"a\":[1,2,3]})\nimport sdata\ndata = sdata.Data(name=\"my_data\", table=df, comment=\"A remarkable comment\")\ndata.metadata.add(\"my_key\", 123, unit=\"m^3\", description=\"a volume\")\ndata.metadata.add(\"force\", 1.234, unit=\"kN\", description=\"x force\")\ndata.to_xlsx(filepath=\"my_data.xlsx\")\nprint(data.metadata.df)\n```\n\n```\n name value dtype unit description\nkey \nname name my_data str - \nuuid uuid 08222ca66e5047808bdc3b35d8f17224 str - \nmy_key my_key 123 int m^3 a volume\nforce force 1.234 float kN x force\n```\n## Howto\n\n \n* [Das sdata-Format - slides](https://lepy.github.io/sdata/ipynb/Das_sdata_Format.slides.html#)\n\n\n## Demo App\n\n* [test the demo app with editor](https://share.streamlit.io/lepy/sdata_streamlit/main/sdata_editor.py)\n\nTry to paste some Excel-Data in the forms ...\n\n\n## Metadata\n\n### Attributes\n\n* name\n* value\n* dtype\n* unit\n* description\n* label\n* required\n\n### dtypes for attributes\n\n* int\n* float\n* str\n* bool\n* timestamp (datetime.isoformat with timezone)\n\n## paper\n\n* [Das sdata-Format](https://zenodo.org/record/4311323#.X89yo9-YXys)\n * Ingolf Lepenies. (2020). Das sdata-Format (Version 0.8.4). http://doi.org/10.5281/zenodo.4311323 \n * [slides](https://lepy.github.io/sdata/ipynb/Das_sdata_Format.slides.html#),\n [html](https://lepy.github.io/sdata/paper/2020/Das_sdata-Format.html), \n [pdf](https://lepy.github.io/sdata/paper/2020/Das_sdata-Format.pdf)\n [temperaturmessung-001.json](https://lepy.github.io/sdata/paper/2020/temperaturmessung-001.json)\n [temperaturmessung-001.xlsx](https://lepy.github.io/sdata/paper/2020/temperaturmessung-001.xlsx)\n \n* [sdata](https://doi.org/10.5281/zenodo.4311396)\n * Ingolf Lepenies. (2020, December 8). sdata - a structured data format (Version 0.8.4). Zenodo. http://doi.org/10.5281/zenodo.4311397\n\n\n\n",
"bugtrack_url": null,
"license": "MIT/Apache-2.0",
"summary": "a structured data format",
"version": "0.23.2",
"project_urls": {
"Homepage": "https://github.com/lepy/sdata"
},
"split_keywords": [
"open",
"data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc41105a9143e8927a6ca7f61d4b160003e226efb96310c96364b78fbf4efa45",
"md5": "39532beb29be0d144b71c83133df6e38",
"sha256": "e5f9c9f36d75b38d749185c3f73401cc4f686533ba69fe2c0ade93f962b8080e"
},
"downloads": -1,
"filename": "sdata-0.23.2.tar.gz",
"has_sig": false,
"md5_digest": "39532beb29be0d144b71c83133df6e38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 139237,
"upload_time": "2024-04-30T13:38:26",
"upload_time_iso_8601": "2024-04-30T13:38:26.339505Z",
"url": "https://files.pythonhosted.org/packages/fc/41/105a9143e8927a6ca7f61d4b160003e226efb96310c96364b78fbf4efa45/sdata-0.23.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 13:38:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lepy",
"github_project": "sdata",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "xlrd",
"specs": [
[
">=",
"1.0.0"
]
]
},
{
"name": "openpyxl",
"specs": [
[
">=",
"3.0"
]
]
},
{
"name": "xlsxwriter",
"specs": [
[
">=",
"1.3"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.16"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.0"
]
]
},
{
"name": "pytz",
"specs": [
[
">=",
"2017.2"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.22.0"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.8"
]
]
},
{
"name": "tables",
"specs": [
[
">=",
"3.5"
]
]
},
{
"name": "Pillow",
"specs": [
[
">=",
"9.0"
]
]
}
],
"tox": true,
"lcname": "sdata"
}
JSON
