Skip to content

docs(python): fix PyPI install command to dnse-sdk-openapi#2

Open
seanpham99 wants to merge 1 commit into
dnse-tech:mainfrom
seanpham99:fix/pypi-install-instructions
Open

docs(python): fix PyPI install command to dnse-sdk-openapi#2
seanpham99 wants to merge 1 commit into
dnse-tech:mainfrom
seanpham99:fix/pypi-install-instructions

Conversation

@seanpham99
Copy link
Copy Markdown

Summary

The Python README instructs users to run pip install openapi-sdk, but no package with that name exists on PyPI (404).

The published distribution for this repository's python/dnse package is dnse-sdk-openapi:
https://pypi.org/project/dnse-sdk-openapi/

This PR updates the install section accordingly and mentions msgpack for websocket-marketdata/ examples (MessagePack encoding).

Changes

  • python/README.md: replace pip install openapi-sdk with pip install dnse-sdk-openapi
  • Add optional msgpack install note for WebSocket examples
  • Add upgrade command example

Test plan

  • Verified pip install dnse-sdk-openapi installs dnse with DNSEClient and TradingClient
  • Confirmed pip install openapi-sdk fails on PyPI

Made with Cursor

The README incorrectly told users to `pip install openapi-sdk`, but that
package name does not exist on PyPI. The published distribution is
dnse-sdk-openapi (https://pypi.org/project/dnse-sdk-openapi/).

Also note msgpack for websocket-marketdata examples.
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.

1 participant