Add Makefile to auto setup repo for developers #699
Conversation
tonywu315
requested review from
JGSweets,
ksneab7,
taylorfturner,
micdavis and
tyfarnan
as code owners
taylorfturner
added
Documentation
|
@tonywu315 add some notes around how to run it in |
Head branch was pushed to by a user without write access
Head branch was pushed to by a user without write access
Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
Makefile
Outdated
| setup: requirements.txt requirements-dev.txt requirements-test.txt | ||
| python -m venv venv | ||
|
|
||
| . venv/bin/activate; \ |
There was a problem hiding this comment.
should these end with && instead of ;?
There was a problem hiding this comment.
&& returns a syntax error: unexpected end of file
There was a problem hiding this comment.
I believe this is bc the last line has \ and shouldn't end in && or ;
There was a problem hiding this comment.
@tonywu315 I would test locally this rec from @JGSweets ... I tested it one way but didn't work on my end
There was a problem hiding this comment.
It works for me if I remove the \ on the last line.
Makefile
Outdated
| pip install -r requirements-test.txt; \ | ||
| pip install -e .; \ | ||
| pre-commit install; \ | ||
| pre-commit run; \ |
There was a problem hiding this comment.
should we make a section for make test and make formatting?
There was a problem hiding this comment.
We could. I see this as just an initial implementation that improves the user experience -- one command to set their environment up, but I'll defer to @tonywu315 as the author of the PR
Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
Makefile
Outdated
| pip install -r requirements-test.txt; \ | ||
| pip install -e .; \ | ||
| pre-commit install; \ | ||
| pre-commit run; \ |
There was a problem hiding this comment.
last line shouldn't have a \
Makefile
Outdated
| . venv/bin/activate && \ | ||
| pip3 install -r requirements.txt && \ | ||
| pip3 install -r requirements-dev.txt && \ | ||
| pip3 install -r requirements-test.txt && \ | ||
| pip3 install -e . && \ | ||
| pre-commit install && \ | ||
| pre-commit run |
There was a problem hiding this comment.
Since this is for dev, I believe we need to include the requirements-reports.txt and requirements-ml.txt for the install as well.
| source ./venv/bin/activate | ||
| ``` | ||
| This Makefile creates a Python virtual environment and installs all of the developer dependencies. Alternatively, follow the steps below. | ||
|
|
There was a problem hiding this comment.
It might be good to also include the other makefile components in readme
No description provided.