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 天内回复