Add Makefile to auto setup repo for developers (#699)

* Add Makefile to auto setup repo for developers * Remove space * Add documentation to use Makefile * Add installs to Makefile * Fix typo * Add another dependency to target * Update Makefile Co-authored-by: Taylor Turner <[email protected]> * Update Makefile Co-authored-by: Taylor Turner <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Taylor Turner <[email protected]> * Update .github/CONTRIBUTING.md Co-authored-by: Taylor Turner <[email protected]> * Update Makefile Co-authored-by: Taylor Turner <[email protected]> * Add make test and format * Add documentation * Remove extra line Co-authored-by: Taylor Turner <[email protected]>
capitalone · Oct 26, 2022 · 3d64af0 · 3d64af0
1 parent 7f8ee52
commit 3d64af0
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -9,6 +9,21 @@ First off, thanks for your input! We love to hear feedback from the community an
 ## We Develop with Github
 We use github to host code, to track issues and feature requests, as well as accept pull requests.
 
+## Makefile Commands
+The Makefile at the root of the repo contains several useful commands.
+
+To setup a Python virtual environment, run the following commands:
+```cli
+make setup
+source ./venv/bin/activate
+```
+
+To format the code, run `make format`.
+
+To test the code, run `make test`.
+
+Alternatively, follow the steps below.
+
 ## Dependencies
 To install the dependencies for developing and updating the code base, be sure to run `pip install -r requirements-dev.txt`
 

diff --git a/Makefile b/Makefile
@@ -0,0 +1,18 @@
+setup: requirements.txt requirements-dev.txt requirements-test.txt
+	python3 -m venv venv
+
+	. venv/bin/activate && \
+	pip3 install -r requirements.txt && \
+	pip3 install -r requirements-dev.txt && \
+	pip3 install -r requirements-ml.txt && \
+	pip3 install -r requirements-reports.txt && \
+	pip3 install -r requirements-test.txt && \
+	pip3 install -e . && \
+	pre-commit install && \
+	pre-commit run
+
+format:
+	pre-commit run
+
+test:
+	DATAPROFILER_SEED=0 python3 -m unittest discover -p "test*.py"