docs(readme): clarify org_id/workspace_id are optional for single-org tokens#22
Merged
Conversation
PyPI README's Configuration table marked org_id / workspace_id as required, but single-org / single-workspace tokens (which is what every fresh user starts with) are auto-resolved server-side. The Required label scared fresh devs into looking up IDs they did not need. - README: drop org_id / workspace_id from Quick Start and error-handling examples; restructure Configuration table with Required + Notes columns explaining auto-resolution. - tests: add a regression test confirming Devhelm() can be constructed with just a token (no env vars, no extra args). The constructor itself already accepted None for both args (see DevhelmConfig in src/devhelm/_http.py); this PR aligns the public docs with the long-standing behaviour. No code-path change, no version bump. Co-authored-by: Cursor <cursoragent@cursor.com>
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
1 participant
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
PyPI README's Configuration table marks
org_idandworkspace_idas Required, but single-org/single-workspace tokens (which every fresh user has) auto-resolve them server-side. The Required label is misleading and adds friction.NonedefaultRound-2 DevEx friction P2 #15.
Test plan
Made with Cursor