# scverse-misc

[![PyPI][badge-pypi]][pypi]
[![Tests][badge-tests]][tests]
[![codecov][badge-codecov]][codecov]
[![Documentation][badge-docs]][documentation]

[badge-pypi]: https://img.shields.io/pypi/v/scverse-misc
[badge-tests]: https://github.com/scverse/scverse-misc/actions/workflows/test.yaml/badge.svg
[badge-codecov]: https://codecov.io/gh/scverse/scverse-misc/graph/badge.svg?token=EUH9BZZK7T
[badge-docs]: https://img.shields.io/readthedocs/scverse-misc

Miscellaneous utility code used by scverse packages

## Getting started

Please refer to the [documentation][],
in particular, the [API documentation][].

## Installation

You need to have Python 3.11 or newer installed on your system.
If you don't have Python installed, we recommend installing [uv][].

There are several alternative options to install scverse-misc:

1. Install the latest release of `scverse-misc` from [PyPI][]:

```bash
pip install scverse-misc
```

2. Install the latest development version:

```bash
pip install git+https://github.com/scverse/scverse-misc.git@main
```

## Release notes

See the [changelog][].

## Contact

For questions and help requests, you can reach out in the [scverse discourse][].
If you found a bug, please use the [issue tracker][].


[uv]: https://github.com/astral-sh/uv
[scverse discourse]: https://discourse.scverse.org/
[issue tracker]: https://github.com/scverse/scverse-misc/issues
[tests]: https://github.com/scverse/scverse-misc/actions/workflows/test.yaml
[codecov]: https://codecov.io/gh/scverse/scverse-misc
[documentation]: https://scverse-misc.readthedocs.io
[changelog]: https://scverse-misc.readthedocs.io/page/changelog.html
[api documentation]: https://scverse-misc.readthedocs.io/page/api.html
[pypi]: https://pypi.org/project/scverse-misc
