Find a file

derAnfaenger 81e6b01300 testing: Add build and coverage badges to README.md		2017-08-23 10:00:38 +02:00
tools	provision: Add option to specify python version.	2017-08-22 11:39:11 -07:00
zulip	twitter: Fix buggy handling of config_file in Python 3.	2017-08-22 17:20:54 -07:00
zulip_bots	bots: Modify is_private function to take 'id' as parameter.	2017-08-22 12:03:09 -07:00
zulip_botserver	flaskserver: Load json python 3 compatible.	2017-08-15 06:38:50 -07:00
.codecov.yml	testing: Add code test coverage reporting.	2017-08-21 15:03:47 -07:00
.gitignore	tools: Diff with requirements.txt in tools/provision.	2017-08-17 10:43:50 -07:00
.travis.yml	testing: Add code test coverage reporting.	2017-08-21 15:03:47 -07:00
README.md	testing: Add build and coverage badges to README.md	2017-08-23 10:00:38 +02:00
requirements.txt	python-zulip-api: Add tools/provision for setting up dev env.	2017-08-17 10:39:00 -07:00

Zulip API

This repository contains the source code for Zulip's PyPI packages:

Development

Fork and clone the Git repo: git clone https://github.com/<your_username>/python-zulip-api.git
Make sure you have pip and virtualenv installed.
cd into the repository cloned earlier: cd python-zulip-api
Run:
```
./tools/provision
```
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 a different Python version, run
```
./tools/provision -p <path_to_your_python_version>`
```
You should now be able to run all the tests within this virtualenv.

You can run the tests for the zulip_bots package by typing:

./tools/test-bots

You can run the tests for the zulip_botserver by typing:

python -m unittest discover -v ./zulip_botserver

To run the linter, type:

./tools/lint