xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
1699 commits 2 branches 0 tags 5.8 MiB
Python 99%
Shell 0.5%
Groovy 0.5%
Find a file
neiljp (Neil Pilgrim) 7339adc7cf requirements: Upgrade to mypy 0.590.
2018-05-02 12:13:26 -07:00
tools deploy: Add tools/deploy delete command. 2018-05-02 23:27:43 +05:30
zulip pypi: Release version 0.4.6. 2018-04-27 01:43:42 -02:30
zulip_bots pypi: Release version 0.4.6. 2018-04-27 01:43:42 -02:30
zulip_botserver pypi: Release version 0.4.6. 2018-04-27 01:43:42 -02:30
.codecov.yml codecov: Adjust failure threshold. 2017-09-14 04:26:12 -07:00
.editorconfig Editing: Add .editorconfig from zulip/zulip (with note). 2017-12-18 07:36:40 -05:00
.gitignore tools/deploy: Add script to deploy bots on a remote bot server. 2018-03-09 06:49:19 -05:00
.travis.yml slack importer: Shift the slack data conversion files to zulip server repo. 2017-12-27 07:54:42 -05:00
mypy.ini mypy: Improve typing of bots & API; enforce no_implicit_optional. 2018-04-06 13:45:11 -04:00
py3_requirements.txt requirements: Upgrade to mypy 0.590. 2018-05-02 12:13:26 -07:00
README.md docs: Mention Python 3 in the README. 2017-11-29 08:32:33 -08:00
requirements.txt requirements: Remove runtime dependency on mock. 2018-01-09 17:01:16 -03:30

README.md

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