You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,8 @@
21
21
22
22
# Pulsar Python client library
23
23
24
+
Pulsar Python clients support a variety of Pulsar features to enable building applications connecting to your Pulsar cluster. For the supported Pulsar features, see [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).
25
+
24
26
## Requirements
25
27
26
28
- Python >= 3.7
@@ -53,21 +55,21 @@ Make sure the PyBind11 submodule has been downloaded and the Pulsar C++ client h
> 1.Here a separate `build` directory is created to store all CMake temporary files. However, the `setup.py` requires the `_pulsar.so`is under the project directory.
66
+
> 1.The separate `build` directory is created to store all CMake temporary files. However, the `setup.py` requires the `_pulsar.so`to be under the project directory.
65
67
> 2. Add the `--force-reinstall` option to overwrite the existing Python wheel in case your system has already installed a wheel before.
66
68
> 3. On Windows, the Python command is `py` instead of `python3`.
67
69
68
70
## Running examples
69
71
70
-
You can run `python3 -c 'import pulsar'` to see whether the wheel has been installed successfully. If it failed, check whether dependencies (e.g. `libpulsar.so`) are in the system path. If not, make sure the dependencies are in `LD_LIBRARY_PATH` (on Linux) or `DYLD_LIBRARY_PATH` (on macOS).
72
+
You can run `python3 -c 'import pulsar'` to see whether the wheel has been installed successfully. If it fails, check whether dependencies (e.g.,`libpulsar.so`) are in the system path. If not, make sure the dependencies are in `LD_LIBRARY_PATH` (on Linux) or `DYLD_LIBRARY_PATH` (on macOS).
71
73
72
74
Then you can run examples as a simple end-to-end test.
73
75
@@ -99,7 +101,7 @@ Run all unit tests:
99
101
./tests/run-unit-tests.sh
100
102
```
101
103
102
-
Run a single unit test (e.g. `PulsarTest.test_tls_auth`):
104
+
Run a single unit test (e.g.,`PulsarTest.test_tls_auth`):
We welcome contributions from the open source community!
127
+
128
+
If your contribution adds Pulsar features for Python clients, you need to update both the [Pulsar docs](https://pulsar.apache.org/docs/client-libraries/) and the [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/). See [Contribution Guide](https://pulsar.apache.org/contribute/site-intro/#pages) for more details.
0 commit comments