From 32fe840193026b8390f471940c7fafd757659e6b Mon Sep 17 00:00:00 2001 From: Alex Hadley Date: Wed, 8 May 2024 11:06:18 -0700 Subject: [PATCH] Update README --- README.md | 15 +++++++++++---- pyproject.toml | 2 +- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c686050..e8e51cf 100644 --- a/README.md +++ b/README.md @@ -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/ diff --git a/pyproject.toml b/pyproject.toml index 0fefb45..d99556a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"]