Skip to content

Commit

Permalink
update conda install instructions (#776)
Browse files Browse the repository at this point in the history
  • Loading branch information
cosmicBboy committed Apr 1, 2022
1 parent 2cef93b commit b571e0f
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ repos:
rev: v5.9.3
hooks:
- id: isort
args: ["--line-length=79"]
args: ["--line-length=79", "--skip=docs/source/conf.py"]

- repo: https://github.com/ikamensh/flynt
rev: '0.69'
Expand Down
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,18 @@ pip install pandera
Using conda:

```
conda install -c conda-forge pandera-core # core library functionality
conda install -c conda-forge pandera # pandera with all extensions
conda install -c conda-forge pandera
```

### Extras

Installing additional functionality:
```

<details>

<summary><i>pip</i></summary>

```bash
pip install pandera[hypotheses] # hypothesis checks
pip install pandera[io] # yaml/script schema io utilities
pip install pandera[strategies] # data synthesis strategies
Expand All @@ -87,9 +91,29 @@ pip install pandera[koalas] # validate koalas dataframes
pip install pandera[modin] # validate modin dataframes
pip install pandera[modin-ray] # validate modin dataframes with ray
pip install pandera[modin-dask] # validate modin dataframes with dask
pip install pandera[all] # all packages
```

</details>

<details>

<summary><i>conda</i></summary>

```bash
conda install -c conda-forge pandera-hypotheses # hypothesis checks
conda install -c conda-forge pandera-io # yaml/script schema io utilities
conda install -c conda-forge pandera-strategies # data synthesis strategies
conda install -c conda-forge pandera-mypy # enable static type-linting of pandas
conda install -c conda-forge pandera-fastapi # fastapi integration
conda install -c conda-forge pandera-dask # validate dask dataframes
conda install -c conda-forge pandera-koalas # validate koalas dataframes
conda install -c conda-forge pandera-modin # validate modin dataframes
conda install -c conda-forge pandera-modin-ray # validate modin dataframes with ray
conda install -c conda-forge pandera-modin-dask # validate modin dataframes with dask
```

</details>

## Quick Start

```python
Expand Down
15 changes: 15 additions & 0 deletions docs/source/_static/default.css
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,21 @@ div.sponsorship {
bottom: 75px !important;
}

/* tabbed content */
.tabbed-set>label {
color: #9ad8bf;
border-color: var(--tabs-color-overline);
}

.tabbed-set>label:hover {
color: #26b079 !important;
}

.tabbed-set>input:checked+label {
color: #26b079;
border-color: #26b079;
}


@media (max-width: 67em) {
.sidebar-drawer {
Expand Down
50 changes: 32 additions & 18 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,39 +103,53 @@ settings. With ``pandera``, you can:
Install
-------

Install with `pip`:
Install with ``pip``:

.. code:: bash
pip install pandera
Or conda:
Or ``conda``:

.. code:: bash
conda install -c conda-forge pandera-core # core library functionality
conda install -c conda-forge pandera # pandera with all extensions
conda install -c conda-forge pandera
Extras
~~~~~~

Installing additional functionality:

.. code:: bash
pip install pandera[hypotheses] # hypothesis checks
pip install pandera[io] # yaml/script schema io utilities
pip install pandera[strategies] # data synthesis strategies
pip install pandera[mypy] # enable static type-linting of pandas
pip install pandera[dask] # validate dask dataframes
pip install pandera[koalas] # validate koalas dataframes
pip install pandera[modin] # validate modin dataframes
pip install pandera[modin-ray] # validate modin dataframes with ray
pip install pandera[modin-dask] # validate modin dataframes with dask
pip install pandera[geopandas] # validate geopandas geodataframes
pip install pandera[all] # all packages
.. tabbed:: pip

.. code:: bash
pip install pandera[hypotheses] # hypothesis checks
pip install pandera[io] # yaml/script schema io utilities
pip install pandera[strategies] # data synthesis strategies
pip install pandera[mypy] # enable static type-linting of pandas
pip install pandera[dask] # validate dask dataframes
pip install pandera[koalas] # validate koalas dataframes
pip install pandera[modin] # validate modin dataframes
pip install pandera[modin-ray] # validate modin dataframes with ray
pip install pandera[modin-dask] # validate modin dataframes with dask
pip install pandera[geopandas] # validate geopandas geodataframes
.. tabbed:: conda

.. code:: bash
conda install -c conda-forge pandera-hypotheses # hypothesis checks
conda install -c conda-forge pandera-io # yaml/script schema io utilities
conda install -c conda-forge pandera-strategies # data synthesis strategies
conda install -c conda-forge pandera-mypy # enable static type-linting of pandas
conda install -c conda-forge pandera-fastapi # fastapi integration
conda install -c conda-forge pandera-dask # validate dask dataframes
conda install -c conda-forge pandera-koalas # validate koalas dataframes
conda install -c conda-forge pandera-modin # validate modin dataframes
conda install -c conda-forge pandera-modin-ray # validate modin dataframes with ray
conda install -c conda-forge pandera-modin-dask # validate modin dataframes with dask
Quick Start
-----------
Expand Down

0 comments on commit b571e0f

Please sign in to comment.