Find a file

Eeshan Garg 13985510b1 tools/release-packages: Isolate the build and cleanup commands. This commit fixes a couple of things: * Removes the command line argument called release_version, now one doesn't have to supply a version number when running just running --cleanup, for instance. * Run --cleanup before building the wheels and sdists. This is so that outdated distributions are removed before generating new ones. * Set IS_PYPA_PACKAGE back to False at the end of the --build process so that we don't accidentally set it to True. This was a huge bug in the previous version of the script.		2017-12-18 21:06:01 -03:30
tools	tools/release-packages: Isolate the build and cleanup commands.	2017-12-18 21:06:01 -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	packaging: Automate the package release process.	2017-10-05 12:01:37 -07:00

README.md

Zulip API

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

zulip: PyPI package for Zulip's API bindings.
zulip_bots: PyPI package for Zulip's bots and bots API.
zulip_botserver: PyPI package for Zulip's Flask bot server.

The source code is written in Python 3.

Development

Fork and clone the Git repo: git clone https://github.com/<your_username>/python-zulip-api.git
Make sure you have pip and virtualenv installed.
cd into the repository cloned earlier: cd python-zulip-api
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>
```
The above step, if successful, will tell you the command to "source" your virtual environment. Run that command!
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