Find a file

Eeshan Garg 81073f9234 packaging: Automate the package release process. This commit adds a script to automate the PyPA release of the zulip, zulip_bots and zulip_botserver packages. The tools/release-packages script would take care of uploading the packages to PyPA, and push commits to both repos updating the package versions. If you have commit access to the repos, you can --push upstream to master. If not, then you can --push origin to a new branch on your fork and create a PR for those changes. Ideally, a release shouldn't take longer than however long it takes one to type the above command. If you have SSH set up on GitHub, you won't need to type in your GitHub username and password. You can also store your PyPA credentials in a file in your home directory; it isn't very secure, but it saves time nevertheless.		2017-10-05 12:01:37 -07:00
tools	packaging: Automate the package release process.	2017-10-05 12:01:37 -07:00
zulip	zephyr: Use add_default_arguments in sync_public_streams.	2017-09-29 16:21:18 -07:00
zulip_bots	packaging: Automate the package release process.	2017-10-05 12:01:37 -07:00
zulip_botserver	packages: Stop hardcoding version in dependency checks.	2017-10-05 12:01:37 -07: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 zulip tests.	2017-09-12 01:27:09 -07: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.

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