Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updating Python installation section #17796

Merged
merged 4 commits into from
Sep 27, 2022

Conversation

tisonkun
Copy link
Member

@tisonkun tisonkun commented Sep 22, 2022

cc @BewareMyPower @shibd @RobertIndie @Demogorgon314 @Anonymitaet

This closes #17794.

Documentation

  • doc-required
    (Your PR needs to update docs and you will update later)

  • doc-not-needed
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

Matching PR in forked repository

N/A

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Sep 22, 2022
Comment on lines -53 to -63
### Install from source

To install the `pulsar-client` library by building from source, follow [instructions](client-libraries-cpp.md#compilation) and compile the Pulsar C++ client library. That builds the Python binding for the library.

To install the built Python bindings:

```shell
git clone https://github.com/apache/pulsar
cd pulsar/pulsar-client-cpp/python
sudo python setup.py install
```
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is simply incorrect. We should update the doc in README.md under pulsar-client-cpp and add back this section to guide users there.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's really complex to build the Python client "correctly" from source right now. See #17468.

@tisonkun
Copy link
Member Author

tisonkun commented Sep 22, 2022

Preview should be almost the same (except style) with the render md version:

image

@tisonkun
Copy link
Member Author

@Anonymitaet comments resolved. Could you give this patch another turn?

@BewareMyPower BewareMyPower merged commit 5e42e4d into apache:master Sep 27, 2022
@tisonkun tisonkun deleted the install-python-client branch September 27, 2022 08:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Updating Python installation section according to C++ client doc structure changes
6 participants