Find a file

PIG208 745f2cd173 zulip_bots: Add a boilerplate bot for external bots. Add packaged_helloworld as an example of a PyPI package setup for an external zulip bot that can be installed via pip and lanuched without the need to include it in the zulip_bots/bots directory.		2021-07-29 11:08:33 -07:00
.github	docs: Create FUNDING.yml.	2021-04-08 06:29:09 -07:00
packaged_helloworld	zulip_bots: Add a boilerplate bot for external bots.	2021-07-29 11:08:33 -07:00
stubs	mypy: Add stubs for zephyr.	2021-03-10 23:59:15 -08:00
tools	gitlint-rules: Remove convoluted binary search for imperative forms.	2021-06-14 13:36:30 -07:00
zulip	slack bridge: Update doc for current version of making Slack bot user.	2021-07-06 16:21:41 -07:00
zulip_bots	bots: Indicate source of bot (from source/module/registry) upon startup.	2021-07-29 11:08:33 -07:00
zulip_botserver	bot_server: Reuse import_module_from_source to load bot modules from paths.	2021-07-22 12:18:34 +08:00
.codecov.yml	codecov: Adjust failure threshold.	2017-09-14 04:26:12 -07:00
.editorconfig	editorconfig: Adjust to 2-space indents for yaml.	2021-02-23 13:51:14 -08:00
.flake8	lint: Disable E203 that will conflict with Black.	2021-05-24 14:02:51 -07:00
.gitignore	gitignore: Add swp files (for vim).	2018-10-11 10:36:00 -04:00
.gitlint	lint: Setup gitlint.	2021-03-04 11:36:47 -08:00
.mailmap	mailmap: Add Git .mailmap for zulipchat.com → zulip.com.	2020-05-13 09:56:35 -07:00
LICENSE	docs: Add more proper LICENSE and THIRDPARTY files.	2020-03-22 16:52:19 -07:00
mypy.ini	mypy: Add stubs for zephyr.	2021-03-10 23:59:15 -08:00
NOTICE	docs: Add more proper LICENSE and THIRDPARTY files.	2020-03-22 16:52:19 -07:00
pyproject.toml	lint: Configure Black.	2021-05-24 14:02:51 -07:00
README.md	docs: Add set and fetch upstream.	2021-03-04 11:36:28 -08:00
requirements.txt	lint: Configure Black.	2021-05-24 14:02:51 -07:00
THIRDPARTY	docs: Add more proper LICENSE and THIRDPARTY files.	2020-03-22 16:52:19 -07:00

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 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, and set upstream to zulip/python-zulip-api:

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

Make sure you have pip.
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, run
```
python3 ./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