Find a file

Eeshan Garg fa759fc97c integrations/trello: Improve the Trello script. This commit makes a bunch of improvements: 1. Use format() for string formatting instead of the old style. 2. Stop returning stuff where we don't have to. 3. URL generation should not be done by the script, especially since our eventual goal is for the Zulip server to automatically generate a webhook URL. So the user should be able to supply the URL in the config file. Plus, this makes it easier to test the script with non-Zulip URLs (such as RequestBin). 4. Removed unnecessary arguments.		2018-04-03 21:52:10 -02:30
tools	mypy: Support files without extensions for scripts in /tools.	2018-03-30 07:54:10 -04:00
zulip	integrations/trello: Improve the Trello script.	2018-04-03 21:52:10 -02:30
zulip_bots	pypa: Release version 0.4.2.	2018-03-31 17:19:23 -02:30
zulip_botserver	pypa: Release version 0.4.2.	2018-03-31 17:19:23 -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
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	requirements: Remove runtime dependency on mock.	2018-01-09 17:01:16 -03:30

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