xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
1522 commits 2 branches 0 tags 5.8 MiB
Python 99%
Shell 0.5%
Groovy 0.5%
Find a file
Eeshan Garg 0e8a40b7c0 tools/release-packages: Document the release process. 
This commit updates the command usage string to also document
the release process briefly.
2017-12-18 23:07:42 -03:30
tools tools/release-packages: Document the release process. 2017-12-18 23:07:42 -03:30
zulip mypy: Add --disallow-any=generics & extend typing accordingly. 2017-12-11 20:14:00 -06:00
zulip_bots interactive bots: Improve documentation for tictactoe bot. 2017-12-18 10:38:13 -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: 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 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