Metadata-Version: 2.4
Name: blisswriter
Version: 3.0.0
Summary: Bliss HDF5 file writer
Maintainer: BCU (ESRF)
License-Expression: MIT
Project-URL: Repository, https://gitlab.esrf.fr/bliss/blisswriter/
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: blissdata[lima2]~=2.4
Requires-Dist: h5py>=3.10
Provides-Extra: tango
Requires-Dist: blissdata[tango]; extra == "tango"
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Requires-Dist: pytest-timeout; extra == "test"
Requires-Dist: blisswriter[tango]; extra == "test"
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: flake8-pep585; extra == "dev"
Requires-Dist: mkdocs<2; extra == "dev"
Requires-Dist: mkdocs-material; extra == "dev"
Dynamic: license-file

# Bliss Writer

Documentation [here](https://bliss.gitlab-pages.esrf.fr/blisswriter).

The `blisswriter` project provides HDF5 file writing based on
data published by `blissdata`.

`blisswriter` is developed and maintained by the [Software group](https://www.esrf.fr/Instrumentation/software)
of the [European Synchrotron](https://www.esrf.fr/).

## Development

The development environments are managed with [pixi](https://pixi.sh). The
available tasks are listed with `pixi task list`.

```bash
pixi run test        # Run the tests
pixi run style       # Check the code formatting (black)
pixi run fix-style   # Format the code (black)
pixi run lint        # Check the linting (flake8)
pixi run docs        # Build the documentation into public/
pixi run build       # Build the packages into dist/
```

The CI runs `style`, `lint`, `test` and `build` against `pixi.lock`, which has
to be committed whenever dependencies change (`pixi install` updates it).

To preview the documentation while editing it:

```bash
pixi run -e tools mkdocs serve
```

The `blisswriter` command can be run from the development environment. Running
the writer requires a Redis database filled by Blissdata:

```bash
pixi run blisswriter run redis://localhost:6379
pixi run blisswriter tango register --help
```
