python-zulip-api/README.md

Zulip API

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

• zulip: PyPI package for Zulip's API bindings.
• zulip_bots: PyPI package for Zulip's bots and bots API.
• zulip_botserver: PyPI package for Zulip's Flask bot server.

Development

1. Fork and clone the Git repo: git clone https://github.com/<your_username>/python-zulip-api.git

2. Make sure you have pip and virtualenv installed.

3. cd into the repository cloned earlier: cd python-zulip-api

4. 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>`
   

5. You should now be able to run all the tests within this virtualenv.

Running tests

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:

./tools/test-botserver

To run the linter, type:

./tools/lint