64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
# Configuring the Python bindings
|
|
|
|
Zulip provides a set of tools that allows interacting with its API more
|
|
easily, called the [Python bindings](https://pypi.python.org/pypi/zulip/).
|
|
One of the most notable use cases for these bindings are bots developed
|
|
using Zulip's [bot framework](/help/writing-bots).
|
|
|
|
In order to use them, you need to configure them with your identity
|
|
(account, API key, and Zulip server URL). There are a few ways to
|
|
achieve that:
|
|
|
|
- Using a [`zuliprc` file](/api/api-keys#download-a-zuliprc-file), referenced via
|
|
the `--config-file` option or the `config_file` option to the
|
|
`zulip.Client` constructor (recommended for bots).
|
|
- Using a [`zuliprc` file](/api/api-keys#download-a-zuliprc-file) in your home
|
|
directory at `~/.zuliprc` (recommended for your own API key).
|
|
- Using the [environment
|
|
variables](https://en.wikipedia.org/wiki/Environment_variable)
|
|
documented [here](/api/api-keys#configuration-keys-and-environment-variables).
|
|
- Using the `--api-key`, `--email`, and `--site` variables as command
|
|
line parameters.
|
|
- Using the `api_key`, `email`, and `site` parameters to the
|
|
`zulip.Client` constructor.
|
|
|
|
## Related articles
|
|
|
|
* [Installation instructions](/api/installation-instructions)
|
|
* [API keys](/api/api-keys)
|
|
* [Running bots](/help/running-bots)
|
|
* [Deploying bots](/help/deploying-bots)
|