diff options
Diffstat (limited to 'python-b2.spec')
| -rw-r--r-- | python-b2.spec | 498 |
1 files changed, 498 insertions, 0 deletions
diff --git a/python-b2.spec b/python-b2.spec new file mode 100644 index 0000000..befe6bf --- /dev/null +++ b/python-b2.spec @@ -0,0 +1,498 @@ +%global _empty_manifest_terminate_build 0 +Name: python-b2 +Version: 3.8.0 +Release: 1 +Summary: Command Line Tool for Backblaze B2 +License: MIT +URL: https://github.com/Backblaze/B2_Command_Line_Tool +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ee/24/559591795e8d390a95b1cbc92c212db1baf875336ab5fb9d1b3477ee6ea4/b2-3.8.0.tar.gz +BuildArch: noarch + + +%description +# B2 Command Line Tool + [](https://github.com/Backblaze/B2_Command_Line_Tool/actions?query=workflow%3A%22Continuous+Integration%22) [](https://pypi.python.org/pypi/b2) [](https://pypi.python.org/pypi/b2) [](https://pypi.python.org/pypi/b2) [](https://b2-command-line-tool.readthedocs.io/en/master/?badge=master) + + + + +The command-line tool that gives easy access to all of the capabilities of B2 Cloud Storage. + +This program provides command-line access to the B2 service. + +# Documentation + +The latest documentation is available on [Read the Docs](https://b2-command-line-tool.readthedocs.io/). + +# Installation + +Detailed instructions on how to install the command line tool can be found [here](https://www.backblaze.com/b2/docs/quick_command_line.html) + +## 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] [--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] [--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 + b2 get-download-auth [-h] [--prefix PREFIX] [--duration DURATION] bucketName + b2 get-download-url-with-auth [-h] [--duration DURATION] bucketName fileName + b2 hide-file [-h] bucketName fileName + b2 list-buckets [-h] [--json] + b2 list-keys [-h] [--long] + b2 list-parts [-h] largeFileId + b2 list-unfinished-large-files [-h] bucketName + 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] [--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 +file to use for caching authentication information. +The default file to use is: `~/.b2_account_info` + +For more details on one command: `b2 <command> --help` + +When authorizing with application keys, this tool requires that the key +have the 'listBuckets' capability so that it can take the bucket names +you provide on the command line and translate them into bucket IDs for the +B2 Storage service. Each different command may required additional +capabilities. You can find the details for each command in the help for +that command. + +## Parallelism and the --threads parameter + +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 many threads could in some cases be detrimental to the other users on your network. + +## Docker image + +An official docker image is provided for these who want to use B2 Command Line Tool in a docker environment. +An example workflow could be (with passing environmental variables): + + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID b2:latest authorize-account + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID b2:latest create-bucket test-bucket allPrivate + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest upload-file test-bucket /data/local-file remote-file + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest ls test-bucket + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest download-file-by-name test-bucket remote-file /data/local-file-2 + +or mapping to a directory where account info will be kept: + + docker run --rm -it -v <absolute-local-path-to-account-info>:/b2 b2:latest authorize-account + docker run --rm -v <absolute-local-path-to-account-info>:/b2 b2:latest create-bucket test-bucket allPrivate + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest upload-file test-bucket /data/local-file remote-file + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest ls test-bucket + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest download-file-by-name test-bucket remote-file /data/local-file-2 + +# Contrib + +## detailed logs + +Verbose logs to stdout can be enabled with the `--verbose` flag. + +A hidden flag `--debugLogs` can be used to enable logging to a `b2_cli.log` file (with log rotation at midnight) in current working directory. Please take care to not launch the tool from the directory that you are syncing, or the logs will get synced to the remote server (unless that is really what you want to do). + +For advanced users, a hidden option `--logConfig <filename.ini>` can be used to enable logging in a user-defined format and verbosity. An example log configuration can be found [here](contrib/debug_logs.ini). + +In order to see the raw request headers you may `export B2_DEBUG_HTTP=1` before calling the cli. + +# Release History + +Please refer to the [changelog](CHANGELOG.md). + +# Developer Info + +Please see our [contributing guidelines](CONTRIBUTING.md). + + +%package -n python3-b2 +Summary: Command Line Tool for Backblaze B2 +Provides: python-b2 +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-b2 +# B2 Command Line Tool + [](https://github.com/Backblaze/B2_Command_Line_Tool/actions?query=workflow%3A%22Continuous+Integration%22) [](https://pypi.python.org/pypi/b2) [](https://pypi.python.org/pypi/b2) [](https://pypi.python.org/pypi/b2) [](https://b2-command-line-tool.readthedocs.io/en/master/?badge=master) + + + + +The command-line tool that gives easy access to all of the capabilities of B2 Cloud Storage. + +This program provides command-line access to the B2 service. + +# Documentation + +The latest documentation is available on [Read the Docs](https://b2-command-line-tool.readthedocs.io/). + +# Installation + +Detailed instructions on how to install the command line tool can be found [here](https://www.backblaze.com/b2/docs/quick_command_line.html) + +## 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] [--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] [--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 + b2 get-download-auth [-h] [--prefix PREFIX] [--duration DURATION] bucketName + b2 get-download-url-with-auth [-h] [--duration DURATION] bucketName fileName + b2 hide-file [-h] bucketName fileName + b2 list-buckets [-h] [--json] + b2 list-keys [-h] [--long] + b2 list-parts [-h] largeFileId + b2 list-unfinished-large-files [-h] bucketName + 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] [--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 +file to use for caching authentication information. +The default file to use is: `~/.b2_account_info` + +For more details on one command: `b2 <command> --help` + +When authorizing with application keys, this tool requires that the key +have the 'listBuckets' capability so that it can take the bucket names +you provide on the command line and translate them into bucket IDs for the +B2 Storage service. Each different command may required additional +capabilities. You can find the details for each command in the help for +that command. + +## Parallelism and the --threads parameter + +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 many threads could in some cases be detrimental to the other users on your network. + +## Docker image + +An official docker image is provided for these who want to use B2 Command Line Tool in a docker environment. +An example workflow could be (with passing environmental variables): + + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID b2:latest authorize-account + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID b2:latest create-bucket test-bucket allPrivate + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest upload-file test-bucket /data/local-file remote-file + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest ls test-bucket + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest download-file-by-name test-bucket remote-file /data/local-file-2 + +or mapping to a directory where account info will be kept: + + docker run --rm -it -v <absolute-local-path-to-account-info>:/b2 b2:latest authorize-account + docker run --rm -v <absolute-local-path-to-account-info>:/b2 b2:latest create-bucket test-bucket allPrivate + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest upload-file test-bucket /data/local-file remote-file + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest ls test-bucket + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest download-file-by-name test-bucket remote-file /data/local-file-2 + +# Contrib + +## detailed logs + +Verbose logs to stdout can be enabled with the `--verbose` flag. + +A hidden flag `--debugLogs` can be used to enable logging to a `b2_cli.log` file (with log rotation at midnight) in current working directory. Please take care to not launch the tool from the directory that you are syncing, or the logs will get synced to the remote server (unless that is really what you want to do). + +For advanced users, a hidden option `--logConfig <filename.ini>` can be used to enable logging in a user-defined format and verbosity. An example log configuration can be found [here](contrib/debug_logs.ini). + +In order to see the raw request headers you may `export B2_DEBUG_HTTP=1` before calling the cli. + +# Release History + +Please refer to the [changelog](CHANGELOG.md). + +# Developer Info + +Please see our [contributing guidelines](CONTRIBUTING.md). + + +%package help +Summary: Development documents and examples for b2 +Provides: python3-b2-doc +%description help +# B2 Command Line Tool + [](https://github.com/Backblaze/B2_Command_Line_Tool/actions?query=workflow%3A%22Continuous+Integration%22) [](https://pypi.python.org/pypi/b2) [](https://pypi.python.org/pypi/b2) [](https://pypi.python.org/pypi/b2) [](https://b2-command-line-tool.readthedocs.io/en/master/?badge=master) + + + + +The command-line tool that gives easy access to all of the capabilities of B2 Cloud Storage. + +This program provides command-line access to the B2 service. + +# Documentation + +The latest documentation is available on [Read the Docs](https://b2-command-line-tool.readthedocs.io/). + +# Installation + +Detailed instructions on how to install the command line tool can be found [here](https://www.backblaze.com/b2/docs/quick_command_line.html) + +## 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] [--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] [--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 + b2 get-download-auth [-h] [--prefix PREFIX] [--duration DURATION] bucketName + b2 get-download-url-with-auth [-h] [--duration DURATION] bucketName fileName + b2 hide-file [-h] bucketName fileName + b2 list-buckets [-h] [--json] + b2 list-keys [-h] [--long] + b2 list-parts [-h] largeFileId + b2 list-unfinished-large-files [-h] bucketName + 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] [--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 +file to use for caching authentication information. +The default file to use is: `~/.b2_account_info` + +For more details on one command: `b2 <command> --help` + +When authorizing with application keys, this tool requires that the key +have the 'listBuckets' capability so that it can take the bucket names +you provide on the command line and translate them into bucket IDs for the +B2 Storage service. Each different command may required additional +capabilities. You can find the details for each command in the help for +that command. + +## Parallelism and the --threads parameter + +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 many threads could in some cases be detrimental to the other users on your network. + +## Docker image + +An official docker image is provided for these who want to use B2 Command Line Tool in a docker environment. +An example workflow could be (with passing environmental variables): + + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID b2:latest authorize-account + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID b2:latest create-bucket test-bucket allPrivate + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest upload-file test-bucket /data/local-file remote-file + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest ls test-bucket + B2_APPLICATION_KEY=<key> B2_APPLICATION_KEY_ID=<key-id> docker run --rm -e B2_APPLICATION_KEY -e B2_APPLICATION_KEY_ID -v <absolute-local-path-to-data>:/data b2:latest download-file-by-name test-bucket remote-file /data/local-file-2 + +or mapping to a directory where account info will be kept: + + docker run --rm -it -v <absolute-local-path-to-account-info>:/b2 b2:latest authorize-account + docker run --rm -v <absolute-local-path-to-account-info>:/b2 b2:latest create-bucket test-bucket allPrivate + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest upload-file test-bucket /data/local-file remote-file + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest ls test-bucket + docker run --rm -v <absolute-local-path-to-account-info>:/b2 -v <absolute-local-path-to-data>:/data b2:latest download-file-by-name test-bucket remote-file /data/local-file-2 + +# Contrib + +## detailed logs + +Verbose logs to stdout can be enabled with the `--verbose` flag. + +A hidden flag `--debugLogs` can be used to enable logging to a `b2_cli.log` file (with log rotation at midnight) in current working directory. Please take care to not launch the tool from the directory that you are syncing, or the logs will get synced to the remote server (unless that is really what you want to do). + +For advanced users, a hidden option `--logConfig <filename.ini>` can be used to enable logging in a user-defined format and verbosity. An example log configuration can be found [here](contrib/debug_logs.ini). + +In order to see the raw request headers you may `export B2_DEBUG_HTTP=1` before calling the cli. + +# Release History + +Please refer to the [changelog](CHANGELOG.md). + +# Developer Info + +Please see our [contributing guidelines](CONTRIBUTING.md). + + +%prep +%autosetup -n b2-3.8.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-b2 -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 3.8.0-1 +- Package Spec generated |