-
Notifications
You must be signed in to change notification settings - Fork 64
Conversation
|
||
git clone git@github.com:<your-username>/undebt.git | ||
|
||
Getting Setup |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have make
targets for each of these steps.
make venv
- sets up virtualenv
- worth adding a reminder to source
venv/bin/activate
make dev
- all of the above + requirements-dev.txt
make test
- all of the above + runs tests
- worth noting that once
make dev
has been run and you are in the virtualenv, you can usetox -e <my-env>
to run tests for just one python, etc
This won't automatically show up in |
It's there? https://github.com/Yelp/undebt/pull/47/files#diff-8aa79b83ed86e48962cc94787fc5cb56R16 |
@lwm Ah, looks good--didn't see that. |
bump! This is good to go or? |
|
||
.. code-block:: bash | ||
|
||
make dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a note after this code block reminding people to source their virtualenv?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's already covered?
|
||
.. _`virtual environment`: http://docs.python-guide.org/en/latest/dev/virtualenvs/ | ||
|
||
Both can be achieved by running: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is "both" referring to here? I only see one thing above that make dev
does, and that's set up your virtual environment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think "both" == "creating virtualenv" + "install project deps"
But I agree this could probably be worded better.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/better/more clearly
@ajm188 lgtm |
lgtm. merging |
thanks @lwm! |
Saw you folks were missing this one. Here's a start!
Closes #48.