Metadata-Version: 2.3
Name: somnio
Version: 0.1.0
Summary: Python library and CLI for sleep and physiological data workflows.
Keywords: sleep,physiology,polysomnography,hdf5,eeg,biosignals,neuroscience,zmax
Author: Ali Saberi
Author-email: Ali Saberi <ali.saberi96@gmail.com>
License: MIT License
         
         Copyright (c) 2026 Ali Saberi
         
         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.
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Dist: numpy>=1.24
Requires-Dist: loguru>=0.7.3 ; extra == 'cli'
Requires-Dist: python-dotenv>=1.0.0 ; extra == 'cli'
Requires-Dist: requests>=2.31.0 ; extra == 'cli'
Requires-Dist: tqdm>=4.67.3 ; extra == 'cli'
Requires-Dist: typer>=0.21.1 ; extra == 'cli'
Requires-Dist: edfio>=0.4 ; extra == 'edf'
Requires-Dist: mne>=1.5 ; extra == 'edf'
Requires-Dist: h5py>=3.8 ; extra == 'hdf5'
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/alitsaberi/somnio
Project-URL: Repository, https://github.com/alitsaberi/somnio
Project-URL: Documentation, https://alitsaberi.github.io/somnio/
Project-URL: Issues, https://github.com/alitsaberi/somnio/issues
Provides-Extra: cli
Provides-Extra: edf
Provides-Extra: hdf5
Description-Content-Type: text/markdown

# Somnio

Python library and CLI for sleep and physiological data workflows.

## Install

```bash
pip install somnio
```

Optional extras:

- `somnio[cli]` — command-line tools
- `somnio[hdf5]` — `somnio.io.hdf5` layouts (requires [h5py](https://www.h5py.org/))

With **uv**: `uv add somnio`, `uv add somnio[cli]`, or `uv add somnio[hdf5]`.

## Documentation

Site source lives under [`docs/`](docs/). Build or serve locally (with the `docs` dependency group installed):

```bash
uv sync --group docs
uv run mkdocs serve
```

Reference material includes [data types](docs/reference/data.md) and [I/O / HDF5](docs/reference/io.md).
