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分
- マージ済み PR（30日）
- 6
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 1週間以上 初心者へのやさしさ 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 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン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 日以内に返信