Python库 | coscmd-1.8.4.4.tar.gz

# COSCMD [](https://travis-ci.org/tencentyun/coscmd) ## 功能说明 使用 COSCMD 工具，用户可通过简单的命令行指令实现对对象（Object）的批量上传、下载、删除等操作。 ## 使用限制 适用于 COS V4、V5 版本；针对 V3 迁移过来的用户也可以使用，但要用 V3 用户的 appid 才可以。 ## 使用环境 ### 系统环境 Windows 或 Linux 系统 (请保证本地字符格式为utf-8，否则操作中文文件会出现异常) ### 软件依赖 Python 2.6/2.7/3.5/3.6 并装有最新版本的 pip #### 安装及配置 环境安装与配置详细操作请参考 [Python 安装与配置](https://cloud.tencent.com/document/product/436/10866)。 ## 下载与安装 - **手动安装** 下载链接：[GitHub 链接](https://github.com/tencentyun/coscmd.git) 在该项目根目录下使用如下命令安装： ``` python setup.py install ``` - **pip 安装** 执行`pip`命令进行安装： ``` pip install coscmd ``` 安装成功之后，用户可以通过`-v`或者`--version`命令查看当前的版本信息。 - **pip 更新** 执行`pip`命令进行更新： ``` pip install coscmd -U ``` > **注意：** 不论是在 Linux 还是 Windows 环境下，都可以通过以上的方法安装或更新。 ## 使用方法 ### 查看 help 用户可通过`-h`或`--help`命令来查看工具的 help 信息。 ``` coscmd -h //查看当面版本信息 ``` help 信息如下所示： ``` usage: cos_cmd.py [-h] [-d] [-b BUCKET] [-r REGION] [-c CONFIG_PATH] [-l LOG_PATH] [-v] {config,upload,download,delete,copy,list,info,mget,restore,signurl,createbucket,deletebucket,putobjectacl,getobjectacl,putbucketacl,getbucketacl} ... an easy-to-use but powerful command-line tool. try 'coscmd -h' to get more informations. try 'coscmd sub-command -h' to learn all command usage, likes 'coscmd upload -h' positional arguments: {config,upload,download,delete,copy,list,info,mget,restore,signurl,createbucket,deletebucket,putobjectacl,getobjectacl,putbucketacl,getbucketacl} config config your information at first. upload upload file or directory to COS. download download file from COS to local. delete delete file or files on COS copy copy file from COS to COS. list list files on COS info get the information of file on COS mget download file from COS to local. restore restore signurl get download url createbucket create bucket deletebucket delete bucket putobjectacl set object acl getobjectacl get object acl putbucketacl set bucket acl getbucketacl get bucket acl optional arguments: -h, --help show this help message and exit -d, --debug debug mode -b BUCKET, --bucket BUCKET set bucket -r REGION, --region REGION set region -c CONFIG_PATH, --config_path CONFIG_PATH set config_path -l LOG_PATH, --log_path LOG_PATH set log_path -v, --version show program's version number and exit ``` 除此之外，用户还可以在每个命令后（不加参数）输入`-h`查看该命令的具体用法，例如： ``` coscmd upload -h //查看 upload 命令使用方法 ``` ### 配置参数 COSCMD 工具在使用前需要进行参数配置。用户可以通过如下命令来配置： ``` coscmd config -a <secret_id> -s <secret_key> -b <bucket> -r <region> [-m <max_thread>] [-p <parts_size>] ``` 上述示例中使用"<>"的字段为必选参数，使用"[]"的字段为可选参数。其中： | 名称 | 描述 | 有效值 | | :---------| :---------------------------------------- | :---- | | secret_id | 必选参数，APPID 对应的密钥 ID，可从控制台获取，参考 [基本概念](https://cloud.tencent.com/doc/product/436/6225)。 | 字符串 | | secret_key | 必选参数，APPID 对应的密钥 Key，可从控制台获取，参考 [基本概念](https://cloud.tencent.com/doc/product/436/6225)。 | 字符串 | | bucket | 必选参数，指定的存储桶名称，bucket的命名规则为{name}-{appid} ，参考 [创建存储桶](https://cloud.tencent.com/doc/product/436/6232)。 | 字符串 | | region | 必选参数，存储桶所在地域。参考 [可用地域](https://cloud.tencent.com/doc/product/436/6224)。 | 字符串 | | max_thread | 可选参数，多线程上传时的最大线程数（默认为 5），有效值：1~10 | 数字 | | parts_size | 可选参数，分块上传的单块大小（单位为 MB，默认为 1MB），有效值：1~10     | 数字   | > **注意：** 1. 可以直接编辑`~/.cos.conf`文件 （在 Windows 环境下，该文件是位于`我的文档`下的一个隐藏文件）。 配置完成之后的`.cos.conf`文件内容示例如下所示： 2. 可以在配置文件中增加`schema`项来选择`http / https`，默认为`https` 3. bucket的命名规则为 `{name}-{appid}` ``` [common] secret_id = AChT4ThiXAbpBDEFGhT4ThiXAbpHIJK secret_key = WE54wreefvds3462refgwewerewr bucket = ABC-1234567890 region = ap-guangzhou max_thread = 5 part_size = 1 schema = https ``` ### 指定 Bucket 的命令 - 通过`-b <bucket> 指定 Bucket`可以指定特定 Bucket。 - Bucket 的命名规则为`{name}-{appid}` ，此处填写的存储桶名称必须为此格式。 ``` coscmd -b <bucket> method ... //命令格式 coscmd -b AAA-12345567 upload a.txt b.txt //操作示例-上传文件 coscmd -b AAA-12344567 createbucket //操作示例-创建bucket ``` ### 创建 Bucket - 建议配合`-b <bucket> 指定 Bucket`使用。 ``` coscmd -b <bucket> createbucket //命令格式 coscmd createbucket //操作示例 coscmd -b AAA-12344567 createbucket //操作示例 ``` ### 删除 Bucket - 建议配合`-b <bucket> 指定 Bucket`使用。 ``` coscmd -b <bucket> deletebucket //命令格式 coscmd createbucket //操作示例 coscmd -b AAA-12344567 deletebucket //操作示例 ``` ### 上传文件或文件夹 - 上传文件命令如下： ``` coscmd upload <localpath> <cospath> //命令格式 coscmd upload /home/aaa/123.txt bbb/123.txt //操作示例 coscmd upload /home/aaa/123.txt bbb/ //操作示例 ``` - 上传文件夹命令如下： ``` coscmd upload -r <localpath> <cospath> //命令格式 coscmd upload -r /home/aaa/ bbb/aaa //操作示例 coscmd upload -r /home/aaa/ bbb/ //操作示例 coscmd upload -r /home/aaa/ / //上传到bucket根目录 coscmd upload -rs /home/aaa/ /home/aaa //同步上传，跳过md5相同的文件 coscmd upload -rs /home/aaa/ /home/aaa --ignore *.txt,*.doc //忽略.txt和.doc的后缀文件 ``` 请将 "<>" 中的参数替换为您需要上传的本地文件路径（localpath），以及 COS 上存储的路径（cospath）。 > **注意：** * 上传文件时需要将cos上的路径包括文件(夹)的名字补全(参考例子)。 * COSCMD 支持大文件断点上传功能。当分片上传大文件失败时，重新上传该文件只会上传失败的分块，而不会从头开始（请保证重新上传的文件的目录以及内容和上传的目录保持一致）。 * COSCMD 分块上传时会对每一块进行 MD5 校验。 * COSMCD 上传默认会携带 `x-cos-meta-md5` 的头部，值为该文件的 `md5` 值 * 使用-s参数可以使用同步上传，跳过上传md5一致的文件(cos上的原文件必须是由1.8.3.2之后的COSCMD上传的，默认带有x-cos-meta-md5的header) * 使用-H参数设置HTTP header时，请务必保证格式为json，这里