xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
1355 commits 2 branches 0 tags 5.8 MiB
Python 99%
Shell 0.5%
Groovy 0.5%
Find a file
Steve Howell f6440e5b65 Require --config-file and simplify command line usage. 
We now require users to specify where their config file is
located, and we no longer default to ~/.zuliprc.

As part of this, we needed to make the "usage" more accurate
in the command line, which I mostly achieved by cutting out
unnecessary stuff.
2017-11-21 09:11:41 -08:00
tools Ignore prior coverage data in tools/test-main. 2017-11-20 12:48:36 -08:00
zulip API: rename get_state & update_state to get_storage & update_storage. 2017-11-18 08:58:47 -08:00
zulip_bots Require --config-file and simplify command line usage. 2017-11-21 09:11:41 -08:00
zulip_botserver bots: Make StateHandler store state on Zulip server. 2017-11-18 08:58:47 -08:00
.codecov.yml codecov: Adjust failure threshold. 2017-09-14 04:26:12 -07:00
.gitignore tools: Add mypy runner. 2017-09-15 13:24:20 +02:00
.travis.yml travis: Run mypy and linter in a single job. 2017-09-27 10:27:37 +02:00
py3_requirements.txt provision: Don't fail on mypy install for Python 2. 2017-09-15 13:24:35 +02:00
README.md README.md: Add command for running mypy. 2017-11-13 12:08:14 +01:00
requirements.txt packaging: Automate the package release process. 2017-10-05 12:01:37 -07:00

README.md

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