diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index abe38a89a..7976a5c83 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,7 +6,7 @@ repos: hooks: - id: black types: [file, python] - language_version: python3.9 + language_version: python3 # Isort: sort import statements # https://github.com/timothycrosley/isort/blob/develop/.pre-commit-hooks.yaml # The setup.cfg holds the compatible config for use with black @@ -15,7 +15,7 @@ repos: rev: 5.10.1 hooks: - id: isort - language_version: python3.9 + language_version: python3 # General fixers: format files for white spaces and trailing new lines, warn on debug statements # https://github.com/pre-commit/pre-commit-hooks#hooks-available - repo: https://github.com/pre-commit/pre-commit-hooks diff --git a/README.md b/README.md index 6d6ec2c26..f7d9ce5c4 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,23 @@ If the ML requirements are too strict (say, you don't want to install tensorflow Install from pypi: `pip install DataProfiler` + +# Contribute If you want to install the dependencies for developing and updating the code base, be sure to run `pip install -r requirements-dev.txt` +## Pre-Commit +To install `pre-commit` hooks, run the following commands: + +```cli +pre-commit install +pre-commit run +``` + +If you want to run the `pre-commit` fresh over over all the files, run the following: +```cli +pre-commit run --all-files +``` + ------------------ # What is a Data Profile?