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

[bug]: clean up Python gRPC client instructions #9285

Closed
ZZiigguurraatt opened this issue Nov 19, 2024 · 0 comments · Fixed by #9287
Closed

[bug]: clean up Python gRPC client instructions #9285

ZZiigguurraatt opened this issue Nov 19, 2024 · 0 comments · Fixed by #9287
Labels
beginner Issues suitable for new developers documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND needs triage

Comments

@ZZiigguurraatt
Copy link

There are some things in the Python gRPC client instructions that were never needed or are no longer needed.

On lines

lnd/docs/grpc/python.md

Lines 20 to 24 in e6efa2e

3. Install dependencies (googleapis-common-protos is required due to the use of
google/api/annotations.proto)
```shell
lnd $ pip install grpcio grpcio-tools googleapis-common-protos mypy-protobuf
```

grpcio googleapis-common-protos mypy-protobuf

can be removed. grpcio is automatically installed by grpcio-tools and googleapis-common-protos is not actually needed because google/api/annotations.proto is not actually needed by the Python gRPC client. As mentioned below, --mypy_out=. does not seem to be actually needed, so that removes the need for mypy-protobuf.

Lines

lnd/docs/grpc/python.md

Lines 25 to 29 in e6efa2e

4. Clone the google api's repository (required due to the use of
google/api/annotations.proto)
```shell
lnd $ git clone https://github.com/googleapis/googleapis.git
```

can be deleted.

On lines

lnd $ python -m grpc_tools.protoc --proto_path=googleapis:. --mypy_out=. --python_out=. --grpc_python_out=. lightning.proto

and

lnd $ python -m grpc_tools.protoc --proto_path=googleapis:. --mypy_out=. --python_out=. --grpc_python_out=. router.proto

--proto_path=googleapis:. can be replaced with --proto_path=.

.

I'm also not sure what --mypy_out=. is for on lines

lnd $ python -m grpc_tools.protoc --proto_path=googleapis:. --mypy_out=. --python_out=. --grpc_python_out=. lightning.proto

and

lnd $ python -m grpc_tools.protoc --proto_path=googleapis:. --mypy_out=. --python_out=. --grpc_python_out=. router.proto

It also does not seem to be needed

Also, I'm not a Ruby user, but I'm guessing references to googleapis in

https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/ruby.md

can probably be removed as well.

@ZZiigguurraatt ZZiigguurraatt added bug Unintended code behaviour needs triage labels Nov 19, 2024
@yyforyongyu yyforyongyu added beginner Issues suitable for new developers documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND and removed bug Unintended code behaviour labels Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginner Issues suitable for new developers documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND needs triage
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants