Repository files navigation

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

• zulip:PyPI packagefor Zulip's API bindings.
• zulip_bots:PyPI packagefor Zulip's bots and bots API.
• zulip_botserver:PyPI packagefor Zulip's Flask Botserver.

The source code is written inPython 3.

This is part of the Zulip open source project; see thecontributing guideandcommit guidelines.

1. Fork and clone the Git repo, and set upstream to zulip/python-zulip-api:

   git clone https://github.com/<your_username>/python-zulip-api.gitcd python-zulip-apigit remote add upstream https://github.com/zulip/python-zulip-api.gitgit fetch upstream

2. Make sure you havepip.

3. Run:

   python3 ./tools/provision

   This sets up a virtual Python environment inzulip-api-py<your_python_version>-venv,where<your_python_version> is your default version of Python. If you would like to specifya different Python version, run

   python3 ./tools/provision -p <path_to_your_python_version>

4. If that succeeds, it will end with printing the following command:

   source /.../python-zulip-api/.../activate

   You can run this command to enter the virtual environment.You'll want to run this in each new shell before running commands frompython-zulip-api.

5. 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 thisvirtual environment.

You can run all the tests with:

pytest

or test individual packages withpytest zulip,pytest zulip_bots,orpytest zulip_botserver (see thepytestdocumentationfor more options).

To run the linter, type:

./tools/lint

To check the type annotations, run:

./tools/run-mypy