refactor(python)!: rename import package sdk -> quicknode_sdk#35
Merged
johnpmitsch merged 2 commits intoMay 29, 2026
Merged
Conversation
The Python distribution has always been published as `quicknode-sdk` on
PyPI, but the import name was the generic `sdk`. That name collides with
any local `sdk/` directory and reads poorly in third-party code — every
other language binding in this repo is namespaced (`quicknode-sdk` crate
in Rust, `@quicknode/sdk` in Node, `quicknode_sdk` in Ruby).
Rename the import path so callers write:
from quicknode_sdk import QuicknodeSdk
The PyPI distribution name (`quicknode-sdk`) and the Rust core crate
name do not change — only the Python import name. No backwards-compat
shim: we're still on the 0.1.x line per repo policy.
Changes:
- maturin `module-name` in both pyproject.toml files
- python/sdk/ directory renamed to python/quicknode_sdk/
- internal `from sdk._core import ...` imports
- all five python/examples/*.py scripts
- python/README.md (6 import examples + error-class import line)
- root README.md project-structure tree
- CLAUDE.md build/consistency notes
- Justfile python-build recipe paths
- .gitignore paths
Verified: `just python-build` succeeds, `from quicknode_sdk import ...`
works, `import sdk` raises ModuleNotFoundError, `cargo check && just
lint` pass.
While the SDK is on the 0.x line, any release may contain breaking changes. Add a short callout pointing readers at the GitHub release notes so upgrades aren't surprising. Mirrored byte-identically across the root README and all four per-language READMEs to satisfy the polyglot consistency rule in CLAUDE.md.
theelderbeever
approved these changes
May 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
sdktoquicknode_sdk. Users now writefrom quicknode_sdk import QuicknodeSdk.quicknode-sdk) and the Rust core crate name do not change — only the Python import path.Why
The old import name (
sdk) is a footgun for users — it shadows any localsdk/directory and reads poorly in third-party code. Every other language binding in this repo is namespaced (quicknode-sdkcrate in Rust,@quicknode/sdkin Node,quicknode_sdkin Ruby). Python was the odd one out.Files changed
pyproject.toml,crates/python/pyproject.toml— maturinmodule-namepython/sdk/→python/quicknode_sdk/(directory rename viagit mv)__init__.py,__init__.pyi,init_manual_override.pyi— internalfrom sdk._core→from quicknode_sdk._corepython/examples/*.pyscriptspython/README.md(6 import examples + error-class import line)README.mdproject-structure treeCLAUDE.mdbuild/consistency notesJustfilepython-buildrecipe paths.gitignorepathsTest plan
just python-buildproduces wheel forquicknode_sdk._corefrom quicknode_sdk import QuicknodeSdk, ApiErrorimports cleanlyimport sdkraisesModuleNotFoundError(old name fully removed)QN_API_KEY, as expected)cargo check && just lintpassjust python-buildon a clean tree to confirm the maturin/stub-gen step still produces matching_core/__init__.pyiLinear: DX-5534