Merge pull request #857 from Backblaze/prepare-3.7.1

Prepare release 3.7.1

Author: ppolewicz

.github/workflows/cd.yml

@@ -83,54 +83,6 @@ jobs:
           draft: ${{ env.ACTIONS_STEP_DEBUG == 'true' }}
           prerelease: false
           files: ${{ steps.sign.outputs.asset_path }}
-  deploy-macos-bundle:
-    needs: deploy
-    env:
-      B2_OSX_CODE_SIGNING_CERTIFICATE: ${{ secrets.B2_OSX_CODE_SIGNING_CERTIFICATE }}
-      B2_OSX_CODE_SIGNING_CERTIFICATE_NAME: ${{ secrets.B2_OSX_CODE_SIGNING_CERTIFICATE_NAME }}
-      B2_OSX_CODE_SIGNING_CERTIFICATE_PASSWORD: ${{ secrets.B2_OSX_CODE_SIGNING_CERTIFICATE_PASSWORD }}
-      B2_OSX_NOTARY_NAME: ${{ secrets.B2_OSX_NOTARY_NAME }}
-      B2_OSX_NOTARY_PASSWORD: ${{ secrets.B2_OSX_NOTARY_PASSWORD }}
-    runs-on: macos-10.15
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up Python ${{ env.PYTHON_DEFAULT_VERSION }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.PYTHON_DEFAULT_VERSION }}
-      - name: Install dependencies
-        run: python -m pip install --upgrade nox pip setuptools
-      - name: Bundle the distribution
-        id: bundle
-        run: nox -vs bundle >> $GITHUB_OUTPUT
-      - name: Import certificate
-        uses: apple-actions/import-codesign-certs@v1
-        with:
-          p12-file-base64: ${{ env.B2_OSX_CODE_SIGNING_CERTIFICATE }}
-          p12-password: ${{ env.B2_OSX_CODE_SIGNING_CERTIFICATE_PASSWORD }}
-      - name: Sign the bundle
-        id: sign
-        run: nox -vs sign -- '${{ env.B2_OSX_CODE_SIGNING_CERTIFICATE_NAME }}' >> $GITHUB_OUTPUT
-      - name: Notarize the bundle
-        if: ${{ env.B2_OSX_NOTARY_NAME != '' }}
-        uses: devbotsxyz/xcode-notarize@v1
-        with:
-          product-path: ${{ steps.sign.outputs.asset_path }}
-          appstore-connect-username: ${{ env.B2_OSX_NOTARY_NAME }}
-          appstore-connect-password: ${{ env.B2_OSX_NOTARY_PASSWORD }}
-          primary-bundle-id: com.backblaze.b2
-      - name: Generate hashes
-        id: hashes
-        run: nox -vs make_dist_digest
-      - name: Upload the bundle to the GitHub release
-        uses: softprops/action-gh-release@v1
-        with:
-          name: ${{ needs.deploy.outputs.version }}
-          draft: ${{ env.ACTIONS_STEP_DEBUG == 'true' }}
-          prerelease: false
-          files: ${{ steps.sign.outputs.asset_path }}
   deploy-windows-bundle:
     needs: deploy
     env:

.github/workflows/ci.yml

@@ -138,7 +138,7 @@ jobs:
           path: ${{ steps.bundle.outputs.asset_path }}
           if-no-files-found: warn
           retention-days: 7
-  test-macos-and-windows-bundle:
+  test-windows-bundle:
     needs: cleanup_buckets
     env:
       B2_TEST_APPLICATION_KEY: ${{ secrets.B2_TEST_APPLICATION_KEY }}
@@ -147,7 +147,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-11, windows-2019]
+        os: [windows-2019, windows-latest]
     steps:
       - uses: actions/checkout@v3
         with:

CHANGELOG.md

@@ -6,9 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.7.1] - 2023-02-08
+
 ### Fixed
 * Remove unnecessary printing options from `rm`
 * Clarify that `--recursive` is required when `--withWildcard` is used
+* Adjust description of `rm`
+
+### Infrastructure
+* Remove macos stand-alone binary from CI/CD
 
 ## [3.7.0] - 2023-02-07
 
@@ -394,7 +400,8 @@ This version is pinned strictly to `b2-sdk-python==1.16.0` for the same reason.
 * 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.
 
-[Unreleased]: https://github.com/Backblaze/B2_Command_Line_Tool/compare/v3.7.0...HEAD
+[Unreleased]: https://github.com/Backblaze/B2_Command_Line_Tool/compare/v3.7.1...HEAD
+[3.7.1]: https://github.com/Backblaze/B2_Command_Line_Tool/compare/v3.7.1...v3.7.1
 [3.7.0]: https://github.com/Backblaze/B2_Command_Line_Tool/compare/v3.6.0...v3.7.0
 [3.6.0]: https://github.com/Backblaze/B2_Command_Line_Tool/compare/v3.5.0...v3.6.0
 [3.5.0]: https://github.com/Backblaze/B2_Command_Line_Tool/compare/v3.4.0...v3.5.0

README.md

@@ -14,28 +14,47 @@ The latest documentation is available on [Read the Docs](https://b2-command-line
 
 # Installation
 
-Stand-alone binaries are available for Linux, MacOS and Windows - this is the most straightforward way to use the 
-command-line tool and is sufficient in most use cases. The latest versions are available for download from the 
-[Releases page](https://github.com/Backblaze/B2_Command_Line_Tool/releases).
+Detailed instructions on how to install the command line tool can be found [here](https://www.backblaze.com/b2/docs/quick_command_line.html)
 
-Alternatively, you can install with:
+## Homebrew
+
+[Homebrew](https://brew.sh/) is widely used in the Mac community, particularly amongst developers. We recommend using the [B2 CLI Homebrew](https://formulae.brew.sh/formula/b2-tools) formula as the quickest setup method for Mac users:
+```
+brew install b2-tools
+```
+
+## Binaries
+
+Stand-alone binaries are available for Linux and Windows - this is the most straightforward way to use the command-line tool and is sufficient in most use cases. The latest versions are available for download from the [Releases page](https://github.com/Backblaze/B2_Command_Line_Tool/releases).
+
+## Python Package Index
+
+You can also install it in your python environment ([virtualenv](https://pypi.org/project/virtualenv/) is recommended) from PyPI with:
 
     pip install b2
 
+## Installing from source
+
+If installing from the repository is needed in order to, for example, check if a pre-release version resolves a bug effectively, it can be installed with:
+
+    python3 setup.py install
+
+In this case of installing a pre-release, [virtualenv](https://pypi.org/project/virtualenv/) is strongly recommended.
+
 # Usage
 
     b2 authorize-account [-h]  [applicationKeyId] [applicationKey]
     b2 cancel-all-unfinished-large-files [-h] bucketName
     b2 cancel-large-file [-h] fileId
     b2 clear-account [-h]
     b2 copy-file-by-id [-h] [--fetchMetadata] [--contentType CONTENTTYPE] [--range RANGE] [--info INFO | --noInfo] [--destinationServerSideEncryption {SSE-B2,SSE-C}] [--destinationServerSideEncryptionAlgorithm {AES256}] [--sourceServerSideEncryption {SSE-C}] [--sourceServerSideEncryptionAlgorithm {AES256}] [--fileRetentionMode {compliance,governance}] [--retainUntil TIMESTAMP] [--legalHold {on,off}] sourceFileId destinationBucketName b2FileName
-    b2 create-bucket [-h] [--bucketInfo BUCKETINFO] [--corsRules CORSRULES] [--lifecycleRules LIFECYCLERULES] [--fileLockEnabled] [--defaultServerSideEncryption {SSE-B2,none}] [--defaultServerSideEncryptionAlgorithm {AES256}] bucketName bucketType
+    b2 create-bucket [-h] [--bucketInfo BUCKETINFO] [--corsRules CORSRULES] [--lifecycleRules LIFECYCLERULES] [--fileLockEnabled] [--replication REPLICATION] [--defaultServerSideEncryption {SSE-B2,none}] [--defaultServerSideEncryptionAlgorithm {AES256}] bucketName bucketType
     b2 create-key [-h] [--bucket BUCKET] [--namePrefix NAMEPREFIX] [--duration DURATION] [--allCapabilities] keyName [capabilities]
     b2 delete-bucket [-h] bucketName
     b2 delete-file-version [-h] [fileName] fileId
     b2 delete-key [-h] applicationKeyId
-    b2 download-file-by-id [-h] [--noProgress] [--sourceServerSideEncryption {SSE-C}] [--sourceServerSideEncryptionAlgorithm {AES256}] fileId localFileName
-    b2 download-file-by-name [-h] [--noProgress] [--sourceServerSideEncryption {SSE-C}] [--sourceServerSideEncryptionAlgorithm {AES256}] bucketName b2FileName localFileName
+    b2 download-file-by-id [-h] [--noProgress] [--threads THREADS] [--sourceServerSideEncryption {SSE-C}] [--sourceServerSideEncryptionAlgorithm {AES256}] [--write-buffer-size BYTES] [--skip-hash-verification] [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE] fileId localFileName
+    b2 download-file-by-name [-h] [--noProgress] [--threads THREADS] [--sourceServerSideEncryption {SSE-C}] [--sourceServerSideEncryptionAlgorithm {AES256}] [--write-buffer-size BYTES] [--skip-hash-verification] [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE] bucketName b2FileName localFileName
     b2 get-account-info [-h]
     b2 get-bucket [-h] [--showSize] bucketName
     b2 get-file-info [-h] fileId
@@ -46,16 +65,22 @@ Alternatively, you can install with:
     b2 list-keys [-h] [--long]
     b2 list-parts [-h] largeFileId
     b2 list-unfinished-large-files [-h] bucketName
-    b2 ls [-h] [--long] [--json] [--versions] [--recursive] [--withWildcard] bucketName [folderName]
-    b2 rm [-h] [--versions] [--recursive] [--withWildcard] [--dryRun] [--threads THREADS] [--queueSize QUEUESIZE] [--noProgress] [--failFast] bucketName [folderName/fileName]
+    b2 ls [-h] [--long] [--json] [--replication] [--versions] [--recursive] [--withWildcard] bucketName [folderName]
+    b2 rm [-h] [--dryRun] [--threads THREADS] [--queueSize QUEUESIZE] [--noProgress] [--failFast] [--versions] [--recursive] [--withWildcard] bucketName [folderName]
     b2 make-url [-h] fileId
     b2 make-friendly-url [-h] bucketName fileName
-    b2 sync [-h] [--noProgress] [--dryRun] [--allowEmptySource] [--excludeAllSymlinks] [--threads THREADS] [--compareVersions {none,modTime,size}] [--compareThreshold MILLIS] [--excludeRegex REGEX] [--includeRegex REGEX] [--excludeDirRegex REGEX] [--excludeIfModifiedAfter TIMESTAMP] [--destinationServerSideEncryption {SSE-B2,SSE-C}] [--destinationServerSideEncryptionAlgorithm {AES256}] [--sourceServerSideEncryption {SSE-C}] [--sourceServerSideEncryptionAlgorithm {AES256}] [--skipNewer | --replaceNewer] [--delete | --keepDays DAYS] [--incrementalMode] source destination
-    b2 update-bucket [-h] [--bucketInfo BUCKETINFO] [--corsRules CORSRULES] [--lifecycleRules LIFECYCLERULES] [--defaultRetentionMode {compliance,governance,none}] [--defaultRetentionPeriod period] [--defaultServerSideEncryption {SSE-B2,none}] [--defaultServerSideEncryptionAlgorithm {AES256}] bucketName bucketType
+    b2 sync [-h] [--noProgress] [--dryRun] [--allowEmptySource] [--excludeAllSymlinks] [--threads THREADS] [--syncThreads SYNCTHREADS] [--downloadThreads DOWNLOADTHREADS] [--uploadThreads UPLOADTHREADS] [--compareVersions {none,modTime,size}] [--compareThreshold MILLIS] [--excludeRegex REGEX] [--includeRegex REGEX] [--excludeDirRegex REGEX] [--excludeIfModifiedAfter TIMESTAMP] [--destinationServerSideEncryption {SSE-B2,SSE-C}] [--destinationServerSideEncryptionAlgorithm {AES256}] [--sourceServerSideEncryption {SSE-C}] [--sourceServerSideEncryptionAlgorithm {AES256}] [--write-buffer-size BYTES] [--skip-hash-verification] [--max-download-streams-per-file MAX_DOWNLOAD_STREAMS_PER_FILE] [--incrementalMode] [--skipNewer | --replaceNewer] [--delete | --keepDays DAYS] source destination
+    b2 update-bucket [-h] [--bucketInfo BUCKETINFO] [--corsRules CORSRULES] [--lifecycleRules LIFECYCLERULES] [--defaultRetentionMode {compliance,governance,none}] [--defaultRetentionPeriod period] [--replication REPLICATION] [--fileLockEnabled] [--defaultServerSideEncryption {SSE-B2,none}] [--defaultServerSideEncryptionAlgorithm {AES256}] bucketName [bucketType]
     b2 upload-file [-h] [--noProgress] [--quiet] [--contentType CONTENTTYPE] [--minPartSize MINPARTSIZE] [--sha1 SHA1] [--threads THREADS] [--info INFO] [--destinationServerSideEncryption {SSE-B2,SSE-C}] [--destinationServerSideEncryptionAlgorithm {AES256}] [--legalHold {on,off}] [--fileRetentionMode {compliance,governance}] [--retainUntil TIMESTAMP] [--incrementalMode] bucketName localFilePath b2FileName
     b2 update-file-legal-hold [-h] [fileName] fileId {on,off}
     b2 update-file-retention [-h] [--retainUntil TIMESTAMP] [--bypassGovernance] [fileName] fileId {governance,compliance,none}
+    b2 replication-setup [-h] [--destination-profile DESTINATION_PROFILE] [--name NAME] [--priority PRIORITY] [--file-name-prefix PREFIX] [--include-existing-files] SOURCE_BUCKET_NAME DESTINATION_BUCKET_NAME
+    b2 replication-delete [-h] SOURCE_BUCKET_NAME REPLICATION_RULE_NAME
+    b2 replication-pause [-h] SOURCE_BUCKET_NAME REPLICATION_RULE_NAME
+    b2 replication-unpause [-h] SOURCE_BUCKET_NAME REPLICATION_RULE_NAME
+    b2 replication-status [-h] [--rule REPLICATION_RULE_NAME] [--destination-profile DESTINATION_PROFILE] [--dont-scan-destination] [--output-format {console,json,csv}] [--noProgress] [--columns COLUMN ONE,COLUMN TWO] SOURCE_BUCKET_NAME
     b2 version [-h]
+    b2 license [-h]
 
 
 The environment variable `B2_ACCOUNT_INFO` specifies the sqlite
@@ -73,11 +98,9 @@ that command.
 
 ## Parallelism and the --threads parameter
 
-Users with high performance networks, or file sets with very small files, may benefit from
-increased parallelism. Experiment with using the `--threads` parameter with small values to
-determine if there are benefits.
+Users with high performance networks, file sets with very small files or high network latency, will usually benefit from increased parallelism. Experiment with using the `--threads` parameter to increase performance.
 
-Note that using multiple threads will usually be detrimental to the other users on your network.
+Note that using many threads could in some cases be detrimental to the other users on your network.
 
 # Contrib
 

README.release.md

@@ -1,21 +1,14 @@
 # Release Process
 
-- Get the Nox:
-  - `pip install -U nox`
 - Update the release history in `CHANGELOG.md`:
   - Change "Unreleased" to the current release version and date.
   - Create empty "Unreleased" section.
   - Add proper link to the new release (at the bottom of the file). Use GitHub [compare feature](https://docs.github.com/en/free-pro-team@latest/github/committing-changes-to-your-project/comparing-commits#comparing-tags) between two tags.
   - Update "Unreleased" link (at the bottom of the file).
 - Copy the main usage string (from `b2 --help`) to `README.md`.
-- Run linters and tests:
-  - `export B2_TEST_APPLICATION_KEY=your_app_key`
-  - `export B2_TEST_APPLICATION_KEY_ID=your_app_key_id`
-  - `nox -x`
-- Build docs locally:
-  - `nox --non-interactive -xs doc`
-- Commit and push to GitHub, then wait for CI workflow to complete successfully.
-  - No need to make a branch. Push straight to `master`.
+- Commit and push to a GitHub branch, then wait for CI workflow to complete successfully.
+- Merge the PR
+- Pull from GitHub
 - Tag in git and push tag to `origin`.  (Version tags look like `v0.4.6`.)
   - `git tag vx.x.x`
   - `git push origin vx.x.x`
@@ -24,4 +17,4 @@
   - Verify that the release has been uploaded to the PyPI
 - Install using `pip` and verify that it gets the correct version:
   - `pip install -U b2`
-- Update https://www.backblaze.com/b2/docs/quick_command_line.html
+- Update https://www.backblaze.com/b2/docs/quick_command_line.html if needed

b2/console_tool.py

@@ -1731,10 +1731,10 @@ def run(self, args):
 
 class AbstractLsCommand(Command, metaclass=ABCMeta):
     """
-    The ``--versions`` option shows all versions of each file, not
+    The ``--versions`` option selects all versions of each file, not
     just the most recent.
 
-    The ``--recursive`` option will descend into folders, and will show
+    The ``--recursive`` option will descend into folders, and will select
     only files, not folders.
 
     The ``--withWildcard`` option will allow using ``*``, ``?`` and ```[]```
@@ -1906,20 +1906,29 @@ def format_ls_entry(self, file_version: FileVersion, replication: bool):
 @B2.register_subcommand
 class Rm(AbstractLsCommand):
     """
-    Removes a group of files.  Use with caution.
+    Removes a "folder" or a set of files matching a pattern.  Use with caution.
+
+    .. note::
+
+        ``rm`` is a high-level command that under the hood utilizes multiple calls to the server,
+        which means the server cannot guarantee consistency between multiple operations. For
+        example if a file matching a pattern is uploaded during a run of ``rm`` command, it MIGHT
+        be deleted (as "latest") instead of the one present when the ``rm`` run has started.
+
+    In order to safely delete a single file version, please use ``delete-file-version``.
 
     To list (but not remove) files to be deleted, use ``--dryRun``.  You can also
-    list files via ``ls`` command – the listing behaviour is exactly the same.
+    list files via ``ls`` command - the listing behaviour is exactly the same.
 
-    Users with high-performance networks or multiple files to be removed, will benefit
-    from multi-threaded capabilities.  The default number of threads is 10.
+    Users with multiple files to be removed will benefit from multi-threaded
+    capabilities.  The default number of threads is 10.
 
     Progress is displayed on the console unless ``--noProgress`` is specified.
 
     {ABSTRACTLSCOMMAND}
 
-    The ``--dryRun`` option prints all the files that
-    would be affected by the command, but removes nothing.
+    The ``--dryRun`` option prints all the files that would be affected by
+    the command, but removes nothing.
 
     Normally, when an error happens during file removal, log is printed and the command
     goes further. If any error should be immediately breaking the command,

noxfile.py

@@ -54,9 +54,6 @@
     "staticx==0.13.5;platform_system=='Linux'",
 ]
 
-OSX_BUNDLE_IDENTIFIER = 'com.backblaze.b2'
-OSX_BUNDLE_ENTITLEMENTS = 'contrib/macos/entitlements.plist'
-
 WINDOWS_TIMESTAMP_SERVER = 'http://timestamp.digicert.com'
 WINDOWS_SIGNTOOL_PATH = 'C:/Program Files (x86)/Windows Kits/10/bin/10.0.17763.0/x86/signtool.exe'
 
@@ -287,28 +284,6 @@ def bundle(session: nox.Session):
 def sign(session):
     """Sign the bundled distribution (macOS and Windows only)."""
 
-    def sign_darwin(cert_name):
-        session.run('security', 'find-identity', external=True, **run_kwargs)
-        session.run(
-            'codesign',
-            '--deep',
-            '--force',
-            '--verbose',
-            '--timestamp',
-            '--identifier',
-            OSX_BUNDLE_IDENTIFIER,
-            '--entitlements',
-            OSX_BUNDLE_ENTITLEMENTS,
-            '--options',
-            'runtime',
-            '--sign',
-            cert_name,
-            'dist/b2',
-            external=True,
-            **run_kwargs
-        )
-        session.run('codesign', '--verify', '--verbose', 'dist/b2', external=True, **run_kwargs)
-
     def sign_windows(cert_file, cert_password):
         session.run('certutil', '-f', '-p', cert_password, '-importpfx', cert_file, **run_kwargs)
         session.run(
@@ -338,15 +313,7 @@ def sign_windows(cert_file, cert_password):
             **run_kwargs
         )
 
-    if SYSTEM == 'darwin':
-        try:
-            certificate_name, = session.posargs
-        except ValueError:
-            session.error('pass the certificate name as a positional argument')
-            return
-
-        sign_darwin(certificate_name)
-    elif SYSTEM == 'windows':
+    if SYSTEM == 'windows':
         try:
             certificate_file, certificate_password = session.posargs
         except ValueError: