5c32054415
Previously, if a bot was accidentally added to a group PM, we would have no option but to leave that conversation because the bot would reply to all the messages sent in that conversation. This also has potential to cause infinite loops in case two bots are added to a group PM since they could keep on replying to each other's messages. Fixes #551. |
||
---|---|---|
tools | ||
zulip | ||
zulip_bots | ||
zulip_botserver | ||
.codecov.yml | ||
.editorconfig | ||
.flake8 | ||
.gitignore | ||
.travis.yml | ||
LICENSE | ||
mypy.ini | ||
NOTICE | ||
README.md | ||
requirements.txt | ||
THIRDPARTY |
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 Botserver.
The source code is written in Python 3.
Development
This is part of the Zulip open source project; see the contributing guide and commit guidelines.
-
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:
python3 ./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, runpython3 ./tools/provision -p <path_to_your_python_version>
-
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 from
python-zulip-api
. -
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
To run the tests for
-
zulip: run
./tools/test-zulip
-
zulip_bots: run
./tools/test-lib && ./tools/test-bots
-
zulip_botserver: run
./tools/test-botserver
To run the linter, type:
./tools/lint
To check the type annotations, run:
./tools/run-mypy