diff --git a/docs/bots-guide.md b/docs/bots-guide.md index 34d4221842..abbf470b55 100644 --- a/docs/bots-guide.md +++ b/docs/bots-guide.md @@ -80,12 +80,18 @@ You need: **Note: Please be considerate when testing experimental bots on public servers such as chat.zulip.org.** -1. Install all requirements. You can either +1. Install all requirements. You can **either** - * run `pip install zulip_bots` for a stable version, or - * clone the [`zulip_bots`](https://github.com/zulip/python-zulip-api/tree/master/zulip_bots) - repository for the latest code. Install it with - `pip -e `; you will be able to make changes to the code. + * run `pip install zulip_bots` for a stable version, **or** + * install the latest version from our repository: + * `git clone https://github.com/zulip/python-zulip-api.git` - clone the [python-zulip-api]( + https://github.com/zulip/python-zulip-api) repository. + * `cd python-zulip-api` - navigate into your cloned repository. + * `./tools/provision` - install all requirements in a Python virtualenv. + * run the `source ` command printed in the previous step to activate the virtualenv. + * *Finished*. You should now see the name of your venv preceding your prompt, e.g. `(ZULIP-~1)`.
+ *Hint: `./tools/provision` installs `zulip`, `zulip_bots`, and `zulip_botserver` in developer + mode. This enables you to make changes to the code after the packages are installed.* 2. Register a new bot user on the Zulip server's web interface.