Skip to content

Commit

Permalink
Update README with badges and PyPI installation
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhad6 committed Aug 23, 2024
1 parent 573ea1e commit ff642a6
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

<!-- start introduction -->

[![PyPI Latest Release](https://img.shields.io/pypi/v/datalogs)](https://pypi.org/project/datalogs/)
[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/datalogs)](https://pypi.org/project/datalogs/)
[![License](https://img.shields.io/pypi/l/paramdb)](https://github.com/PainterQubits/datalogs/blob/main/LICENSE)
[![CI](https://github.com/PainterQubits/datalogs/actions/workflows/ci.yml/badge.svg)](https://github.com/PainterQubits/datalogs/actions/workflows/ci.yml)
[![Documentation Status](https://readthedocs.org/projects/datalogs/badge/?version=latest)](https://datalogs.readthedocs.io)

Python package for logging data from scientific experiments.

<!-- end introduction -->
Expand All @@ -13,14 +19,14 @@ Python package for logging data from scientific experiments.
Install the latest version of DataLogs using pip:

```
pip install -U datalogs --extra-index-url https://painterqubits.github.io/datalogs/releases
pip install -U datalogs
```

To install along with [ParamDB] for support for tagging logs with the latest commit ID,
DataLogs can be installed with the `paramdb` extra:

```
pip install -U "datalogs[paramdb]" --extra-index-url https://painterqubits.github.io/datalogs/releases
pip install -U "datalogs[paramdb]"
```

[ParamDB]: https://paramdb.readthedocs.io/en/stable/
Expand Down

0 comments on commit ff642a6

Please sign in to comment.