This repository contains Python packages for interacting with Zulip, an open-source team chat platform.

Three main packages:

• zulip - API bindings to send messages and interact with Zulip
• zulip_bots - Framework to build and run chatbots
• zulip_botserver - Server for hosting multiple bots

💡 New to open source? This is a beginner-friendly project perfect for your first contribution!

• Python 3.7+ installed
• Git installed
• ~200MB disk space

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

python3 ./tools/provision

This will:

• Create a Python virtual environment
• Install all dependencies
• Set up the project automatically

After setup completes, copy and run the activation command shown in your terminal. It will look something like:

source zulip-api-py3-venv/bin/activate

✅ Done! You're ready to develop.

pytest

`pytest zulip` # Test the main zulip package `pytest zulip_bots` # Test the bots package `pytest zulip_botserver` # Test the Botserver

./tools/lint

./tools/run-mypy

• Want to contribute? → Read the CONTRIBUTING guide. See <CONTRIBUTING.md>.
• Learn the codebase? → Check out individual README files in each package folder
• Need help? → See the main Zulip contributing guide

zulip/ # Main API client zulip_bots/ # Bot framework zulip_botserver/ # Botserver tools/ # Helper scripts (provision, lint, etc.) 

• Open an issue on GitHub
• Ask in Zulip's development community