Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhad6 committed May 8, 2024
1 parent d94e452 commit 32fe840
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,22 @@ Install the latest version of ParamDB using pip:
pip install -U paramdb
```

To install along with [Astropy] for support for storing scalar [`astropy.units.Quantity`]
objects in the database, ParamDB can be installed with the `astropy` extra:
ParamDB has several extras:

- `pandas` for [`pandas.DataFrame`] support via [`paramdb.ParamDataFrame`]
- `astropy` for [`astropy.units.Quantity`] support
- `pydantic` for type-validation support via [Pydantic]

To install all extras, use the `all` extra:

```
pip install -U "paramdb[astropy]"
pip install -U "paramdb[all]"
```

[astropy]: https://docs.astropy.org/en/stable/index.html
[`pandas.DataFrame`]: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html
[`paramdb.ParamDataFrame`]: https://paramdb.readthedocs.io/en/stable/api-reference.html#paramdb.ParamDataFrame
[`astropy.units.quantity`]: https://docs.astropy.org/en/stable/api/astropy.units.Quantity.html#astropy.units.Quantity
[Pydantic]: https://docs.pydantic.dev/latest/

<!-- end installation -->

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pydantic = { version = "^2.7.1", optional = true }
eval-type-backport = { version = "^0.2.0", optional = true }

[tool.poetry.extras]
all = ["pandas", "astropy", "pydantic"]
all = ["pandas", "astropy", "pydantic", "eval-type-backport"]
pandas = ["pandas"]
astropy = ["astropy"]
pydantic = ["pydantic", "eval-type-backport"]
Expand Down

0 comments on commit 32fe840

Please sign in to comment.