Set up Python client
Install Python client library​
Use pip to install the latest version:
pip install 'pulsar-client==3.5.0'
You can install optional components alongside the client library:
# avro serialization
pip install 'pulsar-client[avro]==3.5.0'
# functions runtime
pip install 'pulsar-client[functions]==3.5.0'
# all optional components
pip install 'pulsar-client[all]==3.5.0'
Installation via PyPi is available for the following Python versions:
Platform | Supported Python versions |
---|---|
macOS (>= 11.0) | 3.7, 3.8, 3.9 and 3.10 |
Linux (including Alpine Linux) | 3.7, 3.8, 3.9 and 3.10 |
Connect to Pulsar cluster​
To connect to Pulsar using client libraries, you need to specify a Pulsar protocol URL.
You can assign Pulsar protocol URLs to specific clusters and use the pulsar
scheme. The following is an example of localhost
with the default port 6650
:
pulsar://localhost:6650
If you have multiple brokers, separate IP:port
by commas:
pulsar://localhost:6550,localhost:6651,localhost:6652
If you use mTLS authentication, add +ssl
in the scheme:
pulsar+ssl://pulsar.us-west.example.com:6651