Find a file
2017-08-29 14:24:19 -07:00
tools provision: Use sys.version_info for Python version. 2017-08-24 12:38:20 -07:00
zulip api: Remove unnecessary API key details. 2017-08-29 14:24:19 -07:00
zulip_bots bots: Converter bot does not require a config file. 2017-08-29 14:04:16 -07:00
zulip_botserver api: Ensure automatic tilde expansion. 2017-08-29 14:20:48 -07:00
.codecov.yml testing: Add code test coverage reporting. 2017-08-21 15:03:47 -07:00
.gitignore provision: Add venvs to .gitignore. 2017-08-25 09:31:01 +02:00
.travis.yml travis: Simplify installation process. 2017-08-23 16:40:38 +02:00
README.md testing: Add build and coverage badges to README.md 2017-08-23 10:00:38 +02:00
requirements.txt requirements: Add coverage. 2017-08-23 16:41:02 +02:00

Zulip API

Build status Coverage status

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

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. You should now be able to run all the tests within this virtualenv.

Running tests

You can run the tests for the zulip_bots package by typing:

./tools/test-bots

You can run the tests for the zulip_botserver by typing:

python -m unittest discover -v ./zulip_botserver

To run the linter, type:

./tools/lint