xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

docs: Add python3 to ./tools/provision command.

Browse source 
Documentation tweaked by tabbott.
This commit is contained in:
Shivamgera 2018-03-26 11:03:04 +05:30 committed by Tim Abbott
parent 55d75b11bc
commit 627e9e69d0
1 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -29,19 +29,28 @@ The source code is written in *Python 3*.
4. Run: 4. Run:
``` ```
./tools/provision python3 ./tools/provision
``` ```
This sets up a virtual Python environment in `zulip-api-py<your_python_version>-venv`, This sets up a virtual Python environment in `zulip-api-py<your_python_version>-venv`,
where `<your_python_version>` is your default version of Python. If you would like to specify where `<your_python_version>` is your default version of Python. If you would like to specify
a different Python version, run a different Python version, run
``` ```
./tools/provision -p <path_to_your_python_version> python3 ./tools/provision -p <path_to_your_python_version>
``` ```
5. The above step, if successful, will tell you the command to "source" your 5. If that succeeds, it will print end with printing the following command:
virtual environment. Run that command! ```
source /.../python-zulip-api/.../activate
```
You can run run this command to enter the virtual environment.
You'll want to run this in each new shell before running commands from `python-zulip-api`.
6. You should now be able to run all the tests within this virtualenv. 6. Once you've entered the virtualenv, you should see something like this on the terminal:
```
(zulip-api-py3-venv) user@pc ~/python-zulip-api $
```
You should now be able to run any commands/tests/etc. in this
virtual environment.
### Running tests ### Running tests