Skip to content

Commit

Permalink
update readme and docs
Browse files Browse the repository at this point in the history
Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
  • Loading branch information
cosmicBboy committed Sep 21, 2023
1 parent 28a9bf0 commit 5a15cb1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 31 deletions.
32 changes: 4 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/pandera?style=for-the-badge)](https://anaconda.org/conda-forge/pandera)
[![Discord](https://img.shields.io/badge/discord-chat-purple?color=%235765F2&label=discord&logo=discord&style=for-the-badge)](https://discord.gg/vyanhWuaKB)

`pandera` provides a flexible and expressive API for performing data
validation on dataframe-like objects to make data processing pipelines more
readable and robust.
`pandera` is a [Union.ai](https://union.ai/blog-post/pandera-joins-union-ai) open
source project that provides a flexible and expressive API for performing data
validation on dataframe-like objects to make data processing pipelines more readable and robust.

Dataframes contain information that `pandera` explicitly validates at runtime.
This is useful in production-critical or reproducible research settings. With
Expand Down Expand Up @@ -63,7 +63,7 @@ This is useful in production-critical or reproducible research settings. With

## Documentation

The official documentation is hosted on ReadTheDocs: https://pandera.readthedocs.io
The official documentation is hosted here: https://pandera.readthedocs.io


## Install
Expand Down Expand Up @@ -241,30 +241,6 @@ page or reach out to the maintainers and pandera community on
- Use schemas as generative contracts to [synthesize data](https://pandera.readthedocs.io/en/stable/data_synthesis_strategies.html) for unit testing.
- [Schema inference](https://pandera.readthedocs.io/en/stable/schema_inference.html) allows you to bootstrap schemas from data.

## Alternative Data Validation Libraries

Here are a few other alternatives for validating Python data structures.

**Generic Python object data validation**

- [voloptuous](https://github.com/alecthomas/voluptuous)
- [schema](https://github.com/keleshev/schema)

**`pandas`-specific data validation**

- [opulent-pandas](https://github.com/danielvdende/opulent-pandas)
- [PandasSchema](https://github.com/TMiguelT/PandasSchema)
- [pandas-validator](https://github.com/c-data/pandas-validator)
- [table_enforcer](https://github.com/xguse/table_enforcer)
- [dataenforce](https://github.com/CedricFR/dataenforce)
- [strictly typed pandas](https://github.com/nanne-aben/strictly_typed_pandas)
- [marshmallow-dataframe](https://github.com/facultyai/marshmallow-dataframe)

**Other tools for data validation**

- [great_expectations](https://github.com/great-expectations/great_expectations)
- [frictionless schema](https://framework.frictionlessdata.io/docs/guides/framework/schema-guide/)

## How to Cite

If you use `pandera` in the context of academic or industry research, please
Expand Down
7 changes: 4 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,10 @@ The Open-source Framework for Precision Data Testing

|
``pandera`` provides a flexible and expressive API for performing data
validation on dataframe-like objects to make data processing pipelines more
readable and robust.
``pandera`` is a `Union.ai <https://union.ai/blog-post/pandera-joins-union-ai>`_
open source project that provides a flexible and expressive API for performing data
validation on dataframe-like objects to make data processing pipelines more readable
and robust.

Dataframes contain information that ``pandera`` explicitly validates at runtime.
This is useful in production-critical data pipelines or reproducible research
Expand Down

0 comments on commit 5a15cb1

Please sign in to comment.