Metadata-Version: 2.1
Name: SciDataContainer
Version: 1.1.4
Summary: A container class for the storage of scientific data together with meta data.
Project-URL: Homepage, https://github.com/SciDataContainer/SciDataContainer
Project-URL: Documentation, https://scidatacontainer.readthedocs.io/en/latest
Project-URL: Bug Tracker, https://github.com/SciDataContainer/SciDataContainer/issues
Author-email: Reinhard Caspary <reinhard.caspary@phoenixd.uni-hannover.de>
License: MIT License
        
        Copyright SciDataContainer contributors. All rights reserved.
        
        Permission is hereby granted, free of charge, to any person obtaining
        a copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Requires-Dist: jsonschema[format-nongpl]
Requires-Dist: requests
Description-Content-Type: text/markdown

# SciDataContainer for Python

[![Python package](https://github.com/SciDataContainer/SciDataContainer/actions/workflows/python-package.yml/badge.svg)](https://github.com/SciDataContainer/SciDataContainer/actions/workflows/python-package.yml)
[![codecov](https://codecov.io/gh/SciDataContainer/SciDataContainer/branch/main/graph/badge.svg?token=Q8QSUX2YQM)](https://codecov.io/gh/SciDataContainer/SciDataContainer)

This a Python 3 library for the container file format [SciDataContainer](https://github.com/reincas/scidatacontainer) intended to store scientific data.

## Documenation

You find the [documentation](https://scidatacontainer.readthedocs.io/en/latest/python_library) of the Python package `scidatacontainer` and more on [Read the Docs](https://readthedocs.org/).

## Installation

The easiest way to install the latest version of [`SciDataContainer`](https://pypi.org/project/scidatacontainer/) is using PIP:
```
>>> pip install SciDataContainer
```

## Tests

The tests require the [`coverage`](https://pypi.org/project/coverage/) python package. Run:
```
>>> make report
```
to get a command line coverage report. It's also possible to create a HTML report:
```
>>> make htmlreport
```

