Skip to content

Commit e527d17

Browse files
committed
Merge pull request #516 from helgi/venv
chore(README): use pyenv (built into recent Python) for venv and expand the README
2 parents 0fab17e + 4f6519f commit e527d17

2 files changed

Lines changed: 12 additions & 3 deletions

File tree

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ postgres:
5050
@echo " export PGUSER=postgres"
5151

5252
setup-venv:
53-
@if [ ! -d venv ]; then virtualenv venv; fi
54-
venv/bin/pip install --disable-pip-version-check -q -r rootfs/requirements.txt -r rootfs/dev_requirements.txt
53+
@if [ ! -d venv ]; then pyvenv venv && source venv/bin/activate; fi
54+
pip install --disable-pip-version-check -q -r rootfs/requirements.txt -r rootfs/dev_requirements.txt
5555

5656
test: test-style test-check test-unit test-functional
5757

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,15 @@ helm generate -x manifests deis-dev
5858
helm install deis-dev
5959
```
6060

61+
### Python
62+
63+
Python 3.5 is a minimum requirement and can be installed via [Homebrew](http://brew.sh) for OS X or the package manager of choice on your OS.
64+
65+
With the correct Python in place the quickest way to get up and running is to run `make setup-venv` which will install the Python specific dependencies via [PIP](https://pip.pypa.io/en/stable/) inside an isolated (virtualenv)[https://docs.python.org/3/library/venv.html].
66+
Running `python --version` to verify the correct version is recommend.
67+
68+
Follow the linked documentation to learn about (virtualenv)[https://docs.python.org/3/library/venv.html] and how to `activate` and `deactivate` the environment.
69+
6170
## Testing Your Code
6271

6372
When you've built your new feature or fixed a bug, make sure you've added appropriate unit tests and run `make test` to ensure your code works properly.
@@ -97,4 +106,4 @@ Unless required by applicable law or agreed to in writing, software distributed
97106
[install-k8s]: http://kubernetes.io/gettingstarted/
98107
[repl-controller]: http://kubernetes.io/docs/user-guide/replication-controller/
99108
[issues]: https://github.com/deis/workflow/issues
100-
[prs]: https://github.com/deis/workflow/pulls
109+
[prs]: https://github.com/deis/controller/pulls

0 commit comments

Comments
 (0)