great_expectations README

The project's README from github.com/fivetran/great_expectations. As one markdown file: README.md.

Python Versions PyPI PyPI Downloads Build Status pre-commit.ci Status DOI Twitter Follow Slack Status Contributors Ruff

About GX Core

GX Core combines the collective wisdom of thousands of community members with a proven track record in data quality deployments worldwide, wrapped into a super-simple package for data teams.

Its powerful technical tools start with Expectations: expressive and extensible unit tests for your data. Expectations foster collaboration by giving teams a common language to express data quality tests in an intuitive way. You can automatically generate documentation for each set of validation results, making it easy for everyone to stay on the same page. This not only simplifies your data quality processes, but helps preserve your organization’s institutional knowledge about its data.

Learn more about how data teams are using GX Core in our featured case studies.

Integration support policy

GX Core supports Python 3.10 through 3.13. Experimental support for Python 3.14 and later can be enabled by setting a GX_PYTHON_EXPERIMENTAL environment variable when installing great_expectations.

For data sources and other integrations that GX supports, see the compatibility reference for additional information.

Get started

GX recommends deploying GX Core within a virtual environment. For more information about getting started with GX Core, see Introduction to GX Core.

  1. Run the following command in an empty base directory inside a Python virtual environment to install GX Core:

    pip install great_expectations
    
  2. Run the following command to import the great_expectations module and create a Data Context:

    import great_expectations as gx
    
    context = gx.get_context()
    

Get support from GX and the community

They are listed in the order in which GX is prioritizing the support issues:

  1. Issues and PRs in the GX GitHub repository
  2. Questions posted to the GX Core Discourse forum
  3. Questions posted to the GX Slack community channel

Contribute

We truly value the contributions of our community and always welcome pull requests. PRs are encouraged for both bug fixes and new features. For feature requests, we ask that you first open an issue for discussion to ensure the feature fits within the vision for GX Core and to align on the approach so that your time and effort are well spent. Thank you for being a crucial part of GX Core!

See CONTRIBUTING.md for details on how to propose a change, claim an issue, and submit a pull request.

Code of conduct

Everyone interacting in GX Core project codebases, Discourse forums, Slack channels, and email communications is expected to adhere to the GX Community Code of Conduct.

great_expectations (fivetran/great_expectations)

Searching Database…

What is this?GX Core (Great Expectations) is a Python framework for testing, validating, and documenting the quality of your data. Its core concept is the 'Expectation' — an expressive unit test for your data, built from the collective experience of thousands of data quality deployments.
Is this a library I import into my Python code, or a standalone app?It is a Python library (installed via pip) that you import into your code to define and run data validation checks — not a standalone application with a GUI.
How do I get it running?Inside a Python virtual environment, run the install command for GX Core, then import the greatexpectations module and create a Data Context to start defining Expectations.
Which Python version do I need?GX Core officially supports Python 3.10 through 3.13.
Does GX Core work on the latest Python versions?Python 3.14+ is only experimentally supported — you have to opt in by setting an environment variable before installing.
Who is this built for?It's aimed at data teams and data engineers who need a shared, intuitive way to express and enforce data quality rules across their pipelines.
What is an Expectation in GX Core?An Expectation is an expressive, extensible unit test for your data that gives teams a common language to describe data quality rules in an intuitive way.
Does GX Core generate documentation for my data checks?Yes, it can automatically generate documentation for each set of validation results, which helps preserve institutional knowledge about your data over time.
Creator
fivetran
Size
247.4 MB
Stars
11.9K
Age
9y
Commits · 90 Days