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

Aberta
  • Algo errado?
#595 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

@ffumero2003 já está trabalhando nisso.

Desde 9/9/2026.

  • #603 de @ffumero2003 — aberto

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
18/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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
Linguagem predominante
Python
Estrelas
214
Forks
68
Merge médio
51min
PRs com merge (30d)
6

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de Backblaze/b2-sdk-python

Todas as issues de Backblaze/b2-sdk-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.