docs(examples): add capo Python SDK integration guide - #144
Merged
Merged
Conversation
Add a capo (Python) example page under Developer > Examples in all five locales (en, zh, de, fr, ja), placed next to the boto3 page. The guide connects capo-s3, the S3 client package of the community-driven capo AWS SDK for Python, to RustFS using force_path_style path-style addressing, and covers bucket creation, object upload and listing, streaming get_object reads, presigned URLs, and the asynchronous client (AsyncS3Client with Body.async_from_path). Verified the code samples against a live RustFS instance with capo-s3 0.16.0: sync and async clients, pagination via iter_list_objects_v2, and anonymous fetch of a presigned URL. Closes rustfs/rustfs#8010
|
@majinghe is attempting to deploy a commit to the overtrue's projects Team on Vercel. A member of the Team first needs to authorize it. |
Point readers of developer/sdk/python.md (Boto3 guide) to the capo example page for a community SDK with native async support and full typing, in all five locales. The SDK section stays organized around the official AWS SDKs; capo remains documented as an example recipe.
Point Python users from the boto3 example (Next steps) to the capo example as a community-driven SDK with native async support and full typing, in all five locales. Together with the sdk/python.md cross-link, boto3 and capo now reference each other in both directions.
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
Add a capo (Python) example page under Developer → Examples in all five locales (en, zh, de, fr, ja), placed next to the boto3 page, with navigation entries in each locale's
developer/examples/meta.json.capo is a community-driven AWS SDK for Python with fully typed sync and async clients. Its S3 client ships as
capo-s3(requires Python 3.10+). The page covers:S3Clientwith a customendpoint,Credentials, and nativeforce_path_style=Truepath-style addressing (no botocoreConfigworkaround needed)create_bucket,put_object,list_objects_v2, streamingget_objectreads (context manager), andpresigned_get_objectURLsAsyncS3ClientwithBody.async_from_pathstreaming uploads and async context-manager readsiter_list_objects_v2and a link to the boto3 alternativePlacement and cross-links
The page lives in Developer → Examples, where the other connection recipes live (
boto3,s3cmd,rclone, ...); the SDK section (developer/sdk/) stays organized around the official AWS SDKs, one page per language, and itssdk/index.mdexplicitly recommends official AWS SDKs. For discoverability, Python readers are pointed to capo from both directions, in all five locales:sdk/python.md(Boto3 guide) links the capo example as the community alternative with native async supportexamples/boto3.md(Next steps) links the capo example; the capo page links back to boto3Note: the guide installs
capo-s3rather thancapo— the umbrellacaponame on PyPI is an unrelated guitar-chord library.Verification
rustfs/rustfs:latestvia Docker) with capo-s3 0.16.0: sync/async bucket creation, put/get, listing, pagination, and anonymous fetch of a presigned URL all succeeded (presigned URL returnedhello rustfsvia plain curl).npm run docs:check— PASS (orphans, broken links, fences, banned strings, locale parity all green)npm run build— PASS, 2515 files generated; all five/developer/examples/capopages present indist/public/Related issue
Locales covered
en, zh, de, fr, ja