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

Abierto
  • ¿Algo no está bien?
#595 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@ffumero2003 ya está trabajando en esto.

Desde el 9/9/2026.

  • #603 de @ffumero2003 — abierto

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
18/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Python
Estrellas
214
Forks
68
Merge medio
51 min
PR fusionados (30 d)
6

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Backblaze/b2-sdk-python

Todos los issues de Backblaze/b2-sdk-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.