Description
doc/source/quick_start.rst contains examples that no longer match the public b2sdk.v3 interface. The examples use the nonexistent EncryptionSettings name, construct BasicSyncEncryptionSettingsProvider with only one mapping, pass id= to EncryptionKey, and pass file_infos= to Bucket.upload_local_file.
Steps to reproduce
from b2sdk.v3 import BasicSyncEncryptionSettingsProvider, EncryptionKey
EncryptionKey(secret=b'secret', id='example-key')
BasicSyncEncryptionSettingsProvider({'bucket': None})Also compare the documented file_infos= argument with the current Bucket.upload_local_file(..., file_info=...) signature.
Expected behavior
Quick Start examples should use valid v3 names and signatures and should be usable as a reliable starting point.
Actual behavior
The examples raise NameError or TypeError, or show keywords that are not part of the v3 method signature.
Environment
- Python version: Any supported version
- b2sdk version:
master at f3ab7b71
- OS: Any
Description
doc/source/quick_start.rstcontains examples that no longer match the publicb2sdk.v3interface. The examples use the nonexistentEncryptionSettingsname, constructBasicSyncEncryptionSettingsProviderwith only one mapping, passid=toEncryptionKey, and passfile_infos=toBucket.upload_local_file.Steps to reproduce
Also compare the documented
file_infos=argument with the currentBucket.upload_local_file(..., file_info=...)signature.Expected behavior
Quick Start examples should use valid v3 names and signatures and should be usable as a reliable starting point.
Actual behavior
The examples raise
NameErrororTypeError, or show keywords that are not part of the v3 method signature.Environment
masteratf3ab7b71