B2 SDK docs: add a task-oriented replication guide and public API reference

Offen
  • Stimmt etwas nicht?
#595 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@ffumero2003 arbeitet bereits daran.

Seit 09.9.2026.

  • #603 von @ffumero2003 — offen

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
18/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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: master at f3ab7b71
  • OS: Any
Vorherrschende Sprache
Python
Sterne
214
Forks
68
Ø Merge
51 Min.
Gemergte PRs (30 T.)
6

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Backblaze/b2-sdk-python

Alle Issues in Backblaze/b2-sdk-python

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.