Skip to content

Commit

Permalink
[Docs]Update docs for Client libraries Python (apache#10984)
Browse files Browse the repository at this point in the history
* Update client-libraries-python.md

* Update site2/docs/client-libraries-python.md

Co-authored-by: Anonymitaet <[email protected]>

* Update client-libraries-python.md

* Update client-libraries-python.md

* Update site2/docs/client-libraries-python.md

Co-authored-by: Anonymitaet <[email protected]>
Co-authored-by: Jennifer Huang <[email protected]>
  • Loading branch information
3 people authored Aug 9, 2021
1 parent 674537c commit 9311f7f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions site2/docs/client-libraries-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ title: Pulsar Python client
sidebar_label: Python
---

Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [`python` subdirectory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.
Pulsar Python client library is a wrapper over the existing [C++ client library](client-libraries-cpp.md) and exposes all of the [same features](/api/cpp). You can find the code in the [Python directory](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) of the C++ client code.

All the methods in producer, consumer, and reader of a Python client are thread-safe.

[pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).

## Install

You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from source.
You can install the [`pulsar-client`](https://pypi.python.org/pypi/pulsar-client) library either via [PyPi](https://pypi.python.org/pypi), using [pip](#installation-using-pip), or by building the library from [source](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp).

### Install using pip

Expand Down Expand Up @@ -62,7 +62,7 @@ The complete Python API reference is available at [api/python](/api/python).

## Examples

You can find a variety of Python code examples for the `pulsar-client` library.
You can find a variety of Python code examples for the [pulsar-client](/pulsar-client-cpp/python) library.

### Producer example

Expand Down Expand Up @@ -151,7 +151,7 @@ while True:

In addition to subscribing a consumer to a single Pulsar topic, you can also subscribe to multiple topics simultaneously. To use multi-topic subscriptions, you can supply a regular expression (regex) or a `List` of topics. If you select topics via regex, all topics must be within the same Pulsar namespace.

The following is an example.
The following is an example:

```python
import re
Expand Down Expand Up @@ -405,5 +405,5 @@ This section provides step-by-step instructions on how to use the end-to-end enc
This is from the consumer side.
```
Received msg 'b'encryption message'' id = '(0,0,-1,-1)'
Received msg 'encryption message' id = '(0,0,-1,-1)'
```

0 comments on commit 9311f7f

Please sign in to comment.