README

This project demonstrates the features of the Great Expectations project. For data, it uses the chess game dataset from Kaggle.

It was created by forking my effectivepy python template project.

Getting Started

1. Install python3. The first article in the series linked above should get you started (he recommends pyenv).
2. Install poetry; see the project homepage or this article.
3. Clone this repo.
4. Build the project. If you prefer make, you can run:

make deps

This will run poetry install and poetry run nox --install-only. You can run make help to see more make targets. Alternatively, you can just run poetry's CLI; see the Makefile's make targets for inspiration.

To run the tests:

make test

You can run make with no arguments to list the available make targets.

$ make 
black                          reformat all files for black. good for when someone else needs to read your code.
clean                          clean up project
cov                            run test coverage report
help                           me
lint                           run flake8 linter
safety                         check for open source vulnerabilities with safety
test                           run tests after running black check, flake8, and mypy
thorough                       the full treatment: black check, flake8, mypy, and safety

Configuration

This file has some standard config files:

• The overall project is configured via a PEP518 pyproject.toml file. If you fork this repo, you should probably change it. It contains the black settings, the project dependencies, and a pytest configuration.
• the .gitignore contains obvious gitignores.
• the noxfile.py contains nox targets for running safety and your tests. It uses the nox-poetry project for nox-poetry integration.
• The .flake8 has a minimal flake8 configuration.
• The mypy.ini has a minimal mypy configuration.