All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
3.7.1 - 2023-02-08
- Remove unnecessary printing options from
rm
- Clarify that
--recursive
is required when--withWildcard
is used - Adjust description of
rm
- Remove macos stand-alone binary from CI/CD
3.7.0 - 2023-02-07
- Add
--incrementalMode
tosync
andupload-file
- Add
license
command for printing licenses of b2 and libraries - Add wildcard support for the
ls
command - Add
rm
command
- Stop using b2sdk.v1 in arg_parser.py
- Fix issues when running commands on Python 3.11
- Fix tests after changes introduced in b2sdk 1.19.0
rm
can handle any number of files
- GitHub CI got checkout action updated to v3 and setup-python to v4
- Ensured that changelog validation only happens on pull requests
- GitHub CI uses GITHUB_OUTPUT instead of deprecated set-output
- Releases now feature digests of each file
- Change default Python version in CI/CD to 3.11
- Temporary marking all directories as
safe.directory
inside CI/CD when bundling
3.6.0 - 2022-09-20
- Add
replication-delete
command - Add
replication-pause
command - Add
replication-status
command - Add
replication-unpause
command - Add
--include-existing-files
toreplication-setup
- Add
--max-streams
parameter to download commands - Add
--fileLockEnabled
switch toupdate-bucket
subcommand
- Fix
replication-setup
default priority setter
- Fix warnings in tests
- Fix
test_keys
unit test after changes in b2sdk - Fix running tests on the CI with the latest SDK from the master branch
3.5.0 - 2022-07-27
As in 3.4.0, replication support may be unstable, however no backward-incompatible
changes are currently planned.
This version is pinned strictly to b2-sdk-python==1.17.3
for the same reason.
- Add
--write-buffer-size
parameter - Add
--skip-hash-verification
parameter
- Minimum MacOS version from 10.15 to 11.0
- Try not to crash tests due to bucket name collision
- Fix replication integration tests
- Fix leaking buckets in integration tests
- Limit number of workers for integration tests to 1 for now
- Make integration tests remove buckets only based on name, not based on creation time
- Add dependabot configuration
3.4.0 - 2022-05-04
This release contains a preview of replication support. It allows for basic usage
of B2 replication feature (currently in closed beta). Until this notice is removed,
the interface of replication related functionality should be not considered as public
API (as defined by SemVer).
This version is pinned strictly to b2-sdk-python==1.16.0
for the same reason.
- Add basic replication support to
create-bucket
andupdate-bucket
- Add more fields to
get-account-info
json - Add
--replication
tols --long
- Add
replication-setup
command - Add "quick start guide" to documentation
- Made
bucketType
positional argument toupdate-bucket
optional - Run unit tests on all CPUs
3.3.0 - 2022-04-20
- Add
--threads
parameter todownload-file-by-name
anddownload-file-by-id
- Add
--uploadThreads
and--downloadThreads
parameters tosync
- Add
--profile
switch support - Add
applicationKeyId
andisMasterKey
to the output ofget-account-info
- Rename
--threads
parameter for--sync
to--syncThreads
- Fix license header checker on Windows
- Fix
UnicodeEncodeError
after successful SSE-C download on a non-utf8 terminal (#786)
- Remove official support for python 3.5
- Remove official support for python 3.6
3.2.1 - 2022-02-23
- Fix setting permissions for local sqlite database (thanks to Jan Schejbal for responsible disclosure!)
3.2.0 - 2021-12-23
- Add compatibility support for arrow >= 1.0.2 on newer Python versions while continuing to support Python 3.5
- Fallback to
ascii
decoder when printing help in case the locales are not properly set - Apply the value of
--threads
parameter tosync
downloader threads
3.1.0 - 2021-11-02
- Add
--allCapabilities
tocreate-key
- Add support for Python 3.10
- Fix testing bundle in CI for a new
staticx
version
3.0.3 - 2021-09-27
- Fix pypy selector in CI
- Fix for static linking of Linux binary (CD uses python container)
3.0.2 - 2021-09-17
- Sign Windows binary
- Download instruction in README.md (wording suggested by https://github.com/philh7456)
- Make Linux binary statically linked
3.0.1 - 2021-08-09
- logs from all loggers (in dependencies too) brought back
3.0.0 - 2021-08-07
- Add possibility to change realm during integration tests
- Add possibility to install SDK from local folder instead of pypi when running tests
- Add full support of establishing file metadata when copying, with either source or target using SSE-C
- Add
--noInfo
option tocopy-file-by-id
- Integration test for checking if
bad_bucket_id
error code is returned
- Fix integration tests on non-production environments
- Fix warnings thrown by integration tests
- delete-key unit test adjusted to a less mocked simulator
- Fix integration test cleanup
- Representing encryption-related metadata in buckets and file versions is now consistent
- CLI now uses
b2sdk.v2
- Downloading files prints file metadata as soon as the download commences (not when it finishes)
- New way of establishing location of the SQLite cache file, using
XDG_CONFIG_HOME
env var - Downloaded file's metadata is complete and is displayed before the file is downloaded, a
Download finished
message is issued at the end contentLength
changed tosize
where appropriate- Log configuration: stack traces are not printed in case of errors by default,
--verbose
changes that - Log configuration arguments behaviour altered:
--logConfig
is exclusive with--verbose
and--debugLogs
- Log configuration arguments behaviour altered:
--verbose
and--debugLogs
can be used at the same time (and they will both be taken into account)
- Support of
--metadataDirective
argument incopy-file-by-id
(themetadataDirective
sent to B2 cloud is detected automatically)
2.5.1 - 2021-08-06
SRC_LAST_MODIFIED_MILLIS
import fix
2.5.0 - 2021-05-22
- Add integration test for sync within one bucket with different encryption
- Notarize OSX binary
- File lock arguments and new commands
- Fixed breaking integration test case
- Add zoneinfo to the Windows bundle
- Fixed unit tests failing on new attributes of FileVersionInfo
- Removing old buckets in integration tests
- Bucket name entropy in tests increased
2.4.0 - 2021-04-22
- Sign OSX binary
- Add support for SSE-C server-side encryption mode
- Exclude packages inside the test package when installing
2.3.0 - 2021-03-25
- Add support for SSE-B2 server-side encryption mode
- Pin
setuptools-scm<6.0
as>=6.0
doesn't support Python 3.5 - Fix boot speed regression caused by the
rst2ansi
invocations
2.2.0 - 2021-03-15
- Option to automatically authorize account when running commands other than
authorize-account
viaB2_APPLICATION_KEY_ID
andB2_APPLICATION_KEY
env vars
- Improve setup and teardown for the integration tests
- Use
setuptools-scm
for versioning - Improve CLI and RTD descriptions of the commands
- Add upper version limit for arrow dependency, because of a breaking change
- Fix for the Windows bundled version
- Fix docs autogen
2.1.0 - 2020-11-03
- Add support for Python 3.9
- Add a possibility to append a string to the User-Agent via
B2_USER_AGENT_APPEND
env
- Update
b2 sync
usage text for bucket-to-bucket sync
- Drop Python 2 support 🎉 (for old systems you can now use the binary distribution)
- Remove
--prefix
fromls
(it didn't really work, usefolderName
argument) - Clean up legacy code (
CliBucket
, etc.)
- Fix docs generation in CI
- Correct names of the arguments in
b2 create-key
usage text
2.0.2 - 2020-07-15
- Add
--environment
internal parameter forauthorize-account
2.0.0 - 2020-06-25
- Add official support for python 3.8
- Add
make-friendly-url
command - Add
--excludeIfModifiedAfter
parameter forsync
- Add
--json
parameter tols
andlist-buckets
- Introduce bundled versions of B2 CLI for Linux, Mac OS and Windows
- Switch to b2sdk api version v1: remove output of
delete-bucket
- Use b2sdk >1.1.0: add large file server-side copy
- Switch option parser to argparse: readthedocs documentation is now generated automatically
- Normalize output indentation level to 4 spaces
- Remove the ability to import b2sdk classes through b2cli (please use b2sdk directly)
- Remove official support for python 3.4
- Remove
list-file-names
command. Usels --recursive --json
instead - Remove
list-file-versions
command. Usels --recursive --json --versions
instead
1.4.2 - 2019-10-03
- Add
prefix
parameter tolist-file-names
andlist-file-versions
- Add support for (server-side) copy-file command
- Make parameters of
list-file-names
andlist-file-versions
optional (use an empty string like this:""
) - (b2sdk) Fix sync when used with a key restricted to filename prefix
- When authorizing with application keys, optional application key ID and application key can be added using environment variables B2_APPLICATION_KEY_ID and B2_APPLICATION_KEY respectively.
1.4.0 - 2019-04-25
- (b2sdk) Support for python 3.7
- Renaming accountId for authentication to application key Id Note: this means account Id is still backwards compatible, only the terminology has changed.
- Most of the code moved to b2sdk repository and package
- (b2sdk) Fix transferer crashing on empty file download attempt
- (b2sdk) Enable retries of non-transfer operations
- (b2sdk) Enable continuation of download operations
- Deprecation warning added for imports of sdk classes from cli package
1.3.8 - 2018-12-06
- New
--excludeAllSymlinks
option forsync
. - Faster downloading of large files using multiple threads and bigger buffers.
- Fixed doc for cancel-all-unfinished-large-files
1.3.6 - 2018-08-21
- Fix auto-reauthorize for application keys.
- Fix problem with bash auto-completion module.
- Fix (hopefully) markdown display in PyPI.
1.3.4 - 2018-08-10
- Better documentation for authorize-account command.
- Fix error reporting when using application keys
- Fix auth issues with bucket-restricted application keys.
1.3.2 - 2018-07-28
- Tests fixed for Python 3.7
- Add documentation about what capabilities are required for different commands.
- Better error messages for authorization problems with application keys.
1.3.0 - 2018-07-20
- Support for application keys.
- Support for Python 3.6
- Drop support for Python 3.3 (
setuptools
no longer supports 3.3)
- Faster and more complete integration tests
- Fix content type so markdown displays properly in PyPI
- The testing package is called
test
, nottests
1.2.0 - 2018-07-06
- New
--recursive
option for ls - New
--showSize
option for get-bucket - New
--excludeDirRegex
option for sync
- Include LICENSE file in the source tarball. Fixes #433
- Test suite now runs as root (fixes #427)
- Validate file names before trying to upload
- Fix scaling problems when syncing large numbers of files
- Prefix Windows paths during sync to handle long paths (fixes #265)
- Check if file to be synced is still accessible before syncing (fixes #397)
1.1.0 - 2017-11-30
- Add support for CORS rules in
create-bucket
andupdate-bucket
.get-bucket
will display CORS rules.
- cleanup in integration tests works
1.0.0 - 2017-11-09
- Require
--allowEmptySource
to sync from empty directory, to help avoid accidental deletion of all files.
0.7.4 - 2017-11-09
- More efficient uploads by sending SHA1 checksum at the end.
- File modification times are set correctly when downloading.
- Fix an off-by-one issue when downloading a range of a file (affects library, but not CLI).
- Better handling of some errors from the B2 service.