Skip to content

Update README with gRPC installation instructions#964

Merged
TanYiQing merged 1 commit intoni:masterfrom
KuanHangEmr:users/kuhlee/update_gRPC_installation_info
Apr 27, 2026
Merged

Update README with gRPC installation instructions#964
TanYiQing merged 1 commit intoni:masterfrom
KuanHangEmr:users/kuhlee/update_gRPC_installation_info

Conversation

@KuanHangEmr
Copy link
Copy Markdown
Contributor

@KuanHangEmr KuanHangEmr commented Apr 23, 2026

Added instructions for installing nidaqmx with gRPC support.

- [ ] I've updated CHANGELOG.md if applicable.

- [ ] I've added tests applicable for this pull request

What does this Pull Request accomplish?

Adds documentation to the Installation section of the README explaining how to install nidaqmx with gRPC support using pip install nidaqmx[grpc]. This information was previously undocumented, causing confusion for users who encountered missing dependency errors (e.g., session_pb2) when trying to use nidaqmx over gRPC.
Related bug: #916

Why should this Pull Request be merged?

The [grpc] install extra is the intended way to pull in the required gRPC dependencies, but this was not documented anywhere in the README.

What testing has been done?

This is a documentation change to README.rst. The RST syntax has been visually verified to be consistent with the existing formatting in the file.
image

Added instructions for installing nidaqmx with gRPC support.
@TanYiQing TanYiQing merged commit 501f99a into ni:master Apr 27, 2026
33 checks passed
@KuanHangEmr KuanHangEmr deleted the users/kuhlee/update_gRPC_installation_info branch April 27, 2026 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants