Find a file
Steve Howell 7bc79a8911 Extract StubBotTestCase.make_request_message().
This de-duplicates some code and also makes it a bit
easier in the future to override how we create messages.
2017-12-11 09:39:48 -06:00
tools mypy: Add annotations for Yoda Bot. 2017-12-11 07:33:16 -06:00
zulip slack: fix type annonations. 2017-12-03 10:30:02 -08:00
zulip_bots Extract StubBotTestCase.make_request_message(). 2017-12-11 09:39:48 -06:00
zulip_botserver packaging: Upgrade to release 0.3.9. 2017-11-29 01:23:12 -03:30
.codecov.yml codecov: Adjust failure threshold. 2017-09-14 04:26:12 -07:00
.gitignore interactive bots: Improve googlesearch bot. 2017-12-03 14:03:47 -08:00
.travis.yml slack: Fix travis tests. 2017-12-03 10:30:02 -08:00
py3_requirements.txt provision: Don't fail on mypy install for Python 2. 2017-09-15 13:24:35 +02:00
README.md docs: Mention Python 3 in the README. 2017-11-29 08:32:33 -08:00
requirements.txt packaging: Automate the package release process. 2017-10-05 12:01:37 -07:00

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

  1. Fork and clone the Git repo: git clone https://github.com/<your_username>/python-zulip-api.git

  2. Make sure you have pip and virtualenv installed.

  3. cd into the repository cloned earlier: cd python-zulip-api

  4. Run:

    ./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

    ./tools/provision -p <path_to_your_python_version>
    
  5. The above step, if successful, will tell you the command to "source" your virtual environment. Run that command!

  6. You should now be able to run all the tests within this virtualenv.

Running tests

To run the tests for

  • zulip: run ./tools/test-zulip

  • zulip_bots: run ./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