Find a file

Rhea Parekh 716570ceaa slack: Add zerver_usermessage object and map flags_mask		2017-12-03 10:30:02 -08:00
tools	bot tests: Eliminate BotTestCaseBase.	2017-12-01 07:00:20 -08:00
zulip	slack: Add zerver_usermessage object and map flags_mask	2017-12-03 10:30:02 -08:00
zulip_bots	tests: Refactor `mock_http_conversation` with deduplicating.	2017-12-03 10:26:42 -08:00
zulip_botserver	packaging: Upgrade to release 0.3.9.	2017-11-29 01:23:12 -03:30
.codecov.yml	codecov: Adjust failure threshold.	2017-09-14 04:26:12 -07:00
.gitignore	tools: Add mypy runner.	2017-09-15 13:24:20 +02:00
.travis.yml	slack: Sanitize the message text and fix Travis test.	2017-12-03 10:30:02 -08:00
py3_requirements.txt	provision: Don't fail on mypy install for Python 2.	2017-09-15 13:24:35 +02:00
README.md	docs: Mention Python 3 in the README.	2017-11-29 08:32:33 -08:00
requirements.txt	packaging: Automate the package release process.	2017-10-05 12:01:37 -07:00

Zulip API

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

The source code is written in Python 3.

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>
```
The above step, if successful, will tell you the command to "source" your virtual environment. Run that command!
You should now be able to run all the tests within this virtualenv.

To run the tests for

To run the linter, type:

./tools/lint

To check the type annotations, run:

./tools/run-mypy