xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
1552 commits 2 branches 0 tags 5.8 MiB
Python 99%
Shell 0.5%
Groovy 0.5%
Find a file
Robert Hönig ff65666ac8 Add quit() function to ExternalBotHandler. 
bot_handler.quit() should be used whenever a bot
wishes to terminate. This allows a flexible reaction
suited to the bot's environment: For external bots,
sys.exit() will be called, whereas for embedded bots,
different code can be executed.
2017-12-31 07:12:19 -05:00
tools interactive bots: Create Mention bot. 2017-12-28 16:33:00 -05:00
zulip slack importer: Add README.md. 2017-12-27 07:54:42 -05:00
zulip_bots Add quit() function to ExternalBotHandler. 2017-12-31 07:12:19 -05: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
.editorconfig Editing: Add .editorconfig from zulip/zulip (with note). 2017-12-18 07:36:40 -05:00
.gitignore interactive bots: Improve googlesearch bot. 2017-12-03 14:03:47 -08:00
.travis.yml slack importer: Shift the slack data conversion files to zulip server repo. 2017-12-27 07:54:42 -05:00
py3_requirements.txt requirements: Upgrade to mypy 0.560 & adjust generics flag. 2017-12-21 18:43:42 -05:00
README.md docs: Mention Python 3 in the README. 2017-11-29 08:32:33 -08:00
requirements.txt tools/release-packages: Remove the ability to push changes. 2017-12-18 22:05:54 -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