mirror of
https://github.com/zulip/zulip.git
synced 2025-10-31 20:13:46 +00:00
dbacc00f0f
- Updates `.prettierignore` for the new directory.
- Updates any reference to the API documentation directory for
markdown files to be `api_docs/` instead of `zerver/api/`.
- Removes a reference link from `docs/documentation/api.md` that
hasn't referenced anything in the text since commit 0542c60.
- Update rendering of API documentation for new directory.
105 lines
3.1 KiB
Markdown
105 lines
3.1 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](/api/writing-bots).
|
|
|
|
In order to use them, you need to configure them with your API key and other
|
|
settings. There are two ways to achieve that:
|
|
|
|
- With a file called `.zuliprc`, located in your home directory.
|
|
- With
|
|
[environment variables](https://en.wikipedia.org/wiki/Environment_variable)
|
|
set up in your host machine.
|
|
|
|
A `.zuliprc` file is a plain text document that looks like this:
|
|
|
|
```
|
|
[api]
|
|
key=<API key from the web interface>
|
|
email=<your email address>
|
|
site=<your Zulip server's URI>
|
|
...
|
|
```
|
|
|
|
The keys you can use in this file (and their equivalent environment variables)
|
|
can be found in the following table:
|
|
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th><code>.zuliprc</code> key</th>
|
|
<th>Environment variable</th>
|
|
<th>Required</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td><code>ZULIP_API_KEY</code></td>
|
|
<td>Yes</td>
|
|
<td>
|
|
<a href="/api/api-keys">API key</a>, which you can get through
|
|
Zulip's web interface.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>email</code></td>
|
|
<td><code>ZULIP_EMAIL</code></td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The email address of the user who owns the API key mentioned
|
|
above.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>site</code></td>
|
|
<td><code>ZULIP_SITE</code></td>
|
|
<td>No</td>
|
|
<td>
|
|
URL where your Zulip server is located.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>client_cert_key</code></td>
|
|
<td><code>ZULIP_CERT_KEY</code></td>
|
|
<td>No</td>
|
|
<td>
|
|
Path to the SSL/TLS private key that the binding should use to
|
|
connect to the server.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>client_cert</code></td>
|
|
<td><code>ZULIP_CERT</code></td>
|
|
<td>No*</td>
|
|
<td>
|
|
The public counterpart of <code>client_cert_key</code>/
|
|
<code>ZULIP_CERT_KEY</code>. <i>This setting is required if a cert
|
|
key has been set.</i>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>client_bundle</code></td>
|
|
<td><code>ZULIP_CERT_BUNDLE</code></td>
|
|
<td>No</td>
|
|
<td>
|
|
Path where the server's PEM-encoded certificate is located. CA
|
|
certificates are also accepted, in case those CA's have issued the
|
|
server's certificate. Defaults to the built-in CA bundle trusted
|
|
by Python.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>insecure</code></td>
|
|
<td><code>ZULIP_ALLOW_INSECURE</code></td>
|
|
<td>No</td>
|
|
<td>
|
|
Allows connecting to Zulip servers with an invalid SSL/TLS
|
|
certificate. Please note that enabling this will make the HTTPS
|
|
connection insecure. Defaults to <code>false</code>.
|
|
</td>
|
|
</tr>
|
|
</table>
|