Skip to content

docs: SDK examples, README badges + community files#53

Merged
kj-podonos merged 1 commit into
mainfrom
docs/sdk-examples-polish
Jun 18, 2026
Merged

docs: SDK examples, README badges + community files#53
kj-podonos merged 1 commit into
mainfrom
docs/sdk-examples-polish

Conversation

@kj-podonos

Copy link
Copy Markdown
Contributor

Summary

Developer-facing polish ahead of the public flip — pure additions, no behavior change.

  • examples/ — 5 runnable snippets (quickstart, list workflows, async, error handling, BYO provider keys). Auth via ONEPIN_API_KEY; every call verified against src/onepin/reference.md.
  • README — PyPI / Python-versions / CI / License badges; deepened SDK usage (environments, async, errors/retries/timeouts); fixed stale Status: v0.2.0 → v0.6.0; linked examples/ + reference.md.
  • SUPPORT.md — docs / issues / email / security routing.
  • .editorconfig, .pre-commit-config.yaml — dev-consistency (ruff + hygiene hooks); CI stays source of truth.

Verification

  • ruff check + ruff format --check on examples/ → clean; imports resolve (OnePinClient, AsyncOnePinClient, ApiError, OnePinClientEnvironment).
  • CI lint/mypy/coverage are scoped to onepin._cli + tests; these additions are out of scope → no CI impact.

🤖 Generated with Claude Code

@kj-podonos kj-podonos self-assigned this Jun 17, 2026
@kj-podonos kj-podonos added the documentation Improvements or additions to documentation label Jun 17, 2026
…, pre-commit

Developer-facing polish ahead of the public flip (pure additions, no behavior change):
- examples/ — 5 runnable snippets verified against reference.md
- README — PyPI/pyversions/CI/License badges; deepened SDK usage; fixed stale v0.2.0 -> v0.6.0
- SUPPORT.md, .editorconfig, .pre-commit-config.yaml

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@kj-podonos kj-podonos force-pushed the docs/sdk-examples-polish branch from 28e4b03 to 4bafce7 Compare June 18, 2026 03:32

@kdh-podonos kdh-podonos left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kj-podonos kj-podonos merged commit 4558a18 into main Jun 18, 2026
18 checks passed
@kj-podonos kj-podonos deleted the docs/sdk-examples-polish branch June 18, 2026 03:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants