B2 SDK docs: add a task-oriented replication guide and public API reference
維護者通常 1 天內回覆
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 18/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
Start with the v3 exports of the seven replication classes, then read the implementation under b2sdk/_internal/replication and the tests in test/unit/replication to understand the intended workflow. Check the linked pull request #603 first, since it may already cover this work. Done means a task-oriented replication guide in doc/source plus API-reference entries for each public replication class, including the permissions and failure-status cases.
由索引模型根據 Issue 內容生成。
描述
Description
The v3 interface exports ReplicationConfiguration, ReplicationRule, ReplicationSetupHelper, ReplicationMonitor, ReplicationStatus, ReplicationScanResult, and ReplicationReport. Replication implementation and tests exist under b2sdk/_internal/replication and test/unit/replication, but the Sphinx documentation has no replication guide or dedicated public API-reference section. A user can discover the feature through autocomplete but cannot discover the intended end-to-end workflow from the docs.
Steps to reproduce
from b2sdk.v3 import ReplicationConfiguration, ReplicationMonitor, ReplicationRule
Search doc/source for these classes and observe that they are not documented in a replication workflow.
Expected behavior
Users should be able to configure source and destination buckets, create and update replication rules, understand required application-key capabilities, inspect replication status, and use the monitoring/reporting helpers. The task-oriented guide should explain failure and partial-status cases and link every intentionally public replication class to API reference documentation.
Actual behavior
Replication is exposed by the SDK but is effectively undiscoverable from the published documentation. There is no supported-path example, permissions checklist, conceptual explanation, or API-reference entry in the public documentation tree.
Environment
- Python version: Any supported version
- b2sdk version:
masteratf3ab7b71 - OS: Any
- 主要語言
- Python
- 星號
- 214
- 分支
- 68
- 平均合併
- 51 分鐘
- 30 天內合併 PR
- 6
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
Backblaze/b2-sdk-python 的其他 Issue
-
Download and copy sync actions print remote file names without escape_control_chars可能已有人在做 @dreyfus92 於 15 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
Backblaze/b2-sdk-python#631 ·
維護者通常 1 天內回覆
-
SqliteAccountInfo profile name validation uses "re.match", so only the first character is checked可能已有人在做 @nazarli-shabnam 於 9 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 75/100
Backblaze/b2-sdk-python#629 ·
維護者通常 1 天內回覆
-
Adopt the AI-native SDLC and repository policies可能已有人在做 @goanpeca 於 18 天前認領。 未關閉enhancement
難度 5/5 一週以上 新手友好度 20/100
Backblaze/b2-sdk-python#634 ·
維護者通常 1 天內回覆
-
難度 4/5 3-5 天 新手友好度 50/100
Backblaze/b2-sdk-python#630 ·
維護者通常 1 天內回覆
-
ci: cli-compat fails — 4 sse/sync integration tests broken in B2_Command_Line_Tool (all environments)可能重新可做 @ffumero2003 於 37 天前認領，目前沒有進行中的 PR。 未關閉bug testing
Backblaze/b2-sdk-python#627 · 2 則留言 · 已指派 1 人 ·
維護者通常 1 天內回覆
查看 Backblaze/b2-sdk-python 的全部 Issue
相似的 Issue
-
難度 1/5 1 小時以內 新手友好度 72/100
btclib-org/btclib-node#2505 · 1 則留言 ·
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 78/100
open-webui/open-webui#34462 · 1 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
gorakhargosh/watchdog#1462 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 85/100
openwisp/openwisp-monitoring#889 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
IETF-Hackathon/pqc-certificates#351 ·
維護者通常 2 天內回覆