.. FrameCheck documentation master file

FrameCheck Documentation
========================

A lightweight Python library for defining and validating expectations on pandas DataFrames.

Installation
------------

.. code-block:: bash

   pip install framecheck

Project Links
-------------

- `GitHub <https://github.com/OlivierNDO/framecheck>`_
- `Try in Google Collab <https://colab.research.google.com/github/OlivierNDO/framecheck/blob/main/framecheck_quickstart.ipynb>`_

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   api
   framecheck_methods
   usage_examples