diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a5a1cf122..dce6ffba9 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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' diff --git a/README.md b/README.md index 9a07a3c58..a6cabc2d4 100644 --- a/README.md +++ b/README.md @@ -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: -``` + +
+ +pip + +```bash pip install pandera[hypotheses] # hypothesis checks pip install pandera[io] # yaml/script schema io utilities pip install pandera[strategies] # data synthesis strategies @@ -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 ``` +
+ +
+ +conda + +```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 ```python diff --git a/docs/source/_static/default.css b/docs/source/_static/default.css index 70c4a15a3..974a532ff 100644 --- a/docs/source/_static/default.css +++ b/docs/source/_static/default.css @@ -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 { diff --git a/docs/source/index.rst b/docs/source/index.rst index bf3924123..081606c82 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -103,18 +103,17 @@ 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 @@ -122,20 +121,35 @@ 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 -----------