Skip to content

Commit

Permalink
docs: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rick-jennings committed Oct 11, 2024
1 parent 34adfa1 commit 2eb50e0
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
24 changes: 23 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
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]"
```

0 comments on commit 2eb50e0

Please sign in to comment.