diff --git a/README.md b/README.md index 33c08de..e17757d 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,10 @@ $ pip install phable Phable uses the `zoneinfo` module for IANA time zone support, which by default uses the system's time zone data if available. If no system time zone data is available, then Phable requires the `tzdata` package available on PyPI to be installed. -Phable has an optional `pandas` package dependency that is required for `phable.Grid.to_pandas()` and `phable.Grid.to_pandas_all()`. Download Phable with `pandas` from PyPI using: +Phable has optional `pandas` and `pyarrow` package dependencies that are required for `phable.Grid.to_pandas()` and `phable.Grid.to_pandas_all()`. Download Phable with `pandas` and `pyarrow` from PyPI using: ```console -$ pip install "phable[pandas]" +$ pip install "phable[pandas,pyarrow]" ``` Similarly, Phable has an optional `polars` package dependency that is required for `phable.Grid.to_polars()` and `phable.Grid.to_polars_all()`. Download Phable with `polars` from PyPI using: diff --git a/docs/index.md b/docs/index.md index 1b1c279..510ffae 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,4 +20,26 @@ Haxall features include: - Add, update, and remove commit operations - Evaluation of an Axon string expression -Learn more about `Phable` by exploring the documentation! \ No newline at end of file +Learn more about `Phable` by exploring the documentation! + +## Installation + +Phable requires Python version 3.11 or higher and generally has no required software dependencies. Download Phable from PyPI using: + +```console +$ pip install phable +``` + +Phable uses the `zoneinfo` module for IANA time zone support, which by default uses the system's time zone data if available. If no system time zone data is available, then Phable requires the `tzdata` package available on PyPI to be installed. + +Phable has optional `pandas` and `pyarrow` package dependencies that are required for `phable.Grid.to_pandas()` and `phable.Grid.to_pandas_all()`. Download Phable with `pandas` and `pyarrow` from PyPI using: + +```console +$ pip install "phable[pandas,pyarrow]" +``` + +Similarly, Phable has an optional `polars` package dependency that is required for `phable.Grid.to_polars()` and `phable.Grid.to_polars_all()`. Download Phable with `polars` from PyPI using: + +```console +$ pip install "phable[polars]" +``` \ No newline at end of file