Skip to content

aryanshridhar/python-zulip-api

This branch is 1 commit ahead of, 248 commits behind zulip/python-zulip-api:main.

Folders and files

NameName
Last commit message
Last commit date
Mar 11, 2021
Mar 11, 2021
Mar 11, 2021
Mar 25, 2021
Mar 10, 2021
Mar 10, 2021
Sep 14, 2017
Feb 23, 2021
Apr 19, 2020
Oct 11, 2018
Mar 4, 2021
May 13, 2020
Mar 22, 2020
Mar 22, 2020
Mar 4, 2021
Mar 22, 2020
Mar 11, 2021
Mar 4, 2021

Repository files navigation

Zulip API

Build status Coverage status

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

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.

  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.git
    cd python-zulip-api
    git remote add upstream https://github.com/zulip/python-zulip-api.git
    git fetch upstream
    
  2. Make sure you have pip.

  3. 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>
    
  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 from python-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 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

Packages

No packages published

Languages

  • Python 99.0%
  • Other 1.0%