Skip to content

Commit fee8d1d

Browse files
authored
Update README.md (#117)
1 parent cf2c7c4 commit fee8d1d

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121

2222
# Pulsar Python client library
2323

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+
2426
## Requirements
2527

2628
- Python >= 3.7
@@ -53,21 +55,21 @@ Make sure the PyBind11 submodule has been downloaded and the Pulsar C++ client h
5355

5456
```bash
5557
cmake -B build
56-
cmake --build build
58+
cmake --build build
5759
cmake --install build
5860
python3 ./setup.py bdist_wheel
5961
python3 -m pip install dist/pulsar_client-*.whl --force-reinstall
6062
```
6163

6264
> **NOTE**
6365
>
64-
> 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.
6567
> 2. Add the `--force-reinstall` option to overwrite the existing Python wheel in case your system has already installed a wheel before.
6668
> 3. On Windows, the Python command is `py` instead of `python3`.
6769
6870
## Running examples
6971

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).
7173

7274
Then you can run examples as a simple end-to-end test.
7375

@@ -99,7 +101,7 @@ Run all unit tests:
99101
./tests/run-unit-tests.sh
100102
```
101103

102-
Run a single unit test (e.g. `PulsarTest.test_tls_auth`):
104+
Run a single unit test (e.g., `PulsarTest.test_tls_auth`):
103105

104106
```bash
105107
python3 ./tests/pulsar_test.py 'PulsarTest.test_tls_auth'
@@ -118,3 +120,9 @@ pydoctor --make-html \
118120
--html-output=<path-to-apidocs> \
119121
pulsar
120122
```
123+
124+
## Contribute
125+
126+
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

Comments
 (0)