用于cosmosid api的命令行客户机和python 3库
cosmosid-cli的Python项目详细描述
cosmos id
=====
用于与cosmosid api交互的命令行界面（cli）和python 3客户端库。
>仅适用于python3，python 2.7尚不支持。
>要求
>操作包
~~~~~~~~~~~
>-python3-python3-pip
>python 3-python包
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>-boto3
-cli是的安装
==
此包提供：\*核心python 3客户端库；\*一个简单的cli
用于与使用核心库的cosmosid交互；
基本安装
----
3’。\*
只需从控制台"sudo pip3 install cosmosid_cli"运行
注意：pip3和setuptools应升级到最新版本。
在安装cosmosid cli之前，请更新工作站上有关
操作系统更新过程的软件包。
。代码：：shell
例如，对于ubuntu 14.04，执行以下步骤：
$sudo apt get update
$sudo apt get upgrade
$sudo-h pip3 install-u pip setuptools
离子。代码：：shell
$sudo-h pip3 install--upgrade cosmosid_cli
要通过cosmosid api密钥自动进行身份验证，您应该创建
凭据文件` ~/.cosmosid``并将您的api密钥以以下格式存储在其中：
。代码：：json
{"api_key"："<；您的api密钥字符串"}
您可以直接使用cosmosid api密钥，而不是将其存储在
凭据文件中。要使用api密钥身份验证，请将密钥作为
参数传递给"cosmosid"命令：
。代码：：shell
cosmosid--api_key=your_api_key<；command>；
cosmosid cli\*1支持多种类型的命令。用于从COSMOSID云检索数据到终端（输出）的命令-文件，分析。\*2。用于将元基因组或扩增子样本上载到用于分析的Cosmosid云的命令-上载。\*3。用于从cosmosid cloud检索报告存档的命令-reports
注意：每个命令都有选项。要获取每个cosmosid cli
命令的使用信息，用户只需运行``cosmosid<；command>；--help``
>检索文件
~~~~~~~~~~~~~~~~
>检索数据的命令具有输出格式选项。用户可以以不同的格式（csv、json、table、value、yaml（table是默认值）将数据输入终端（或其他输出），并指定要显示的列。另外还有csv格式选项，用户可以引用
或不引用或部分引用输出值-all、minimal、none、non-numeric（默认情况下只引用非数值）
代码：：shell
$cosmosid files--help
用法：cosmosid files[-h[-f{csv，json，table，value，yaml}[-c column]
[-noindent][--max width<；integer>；][--fit width]
[-print empty][--quote{all，minimal，none，nonnumeric}
[--parent parent]
[--order{type，name，id，status，size，created}[--up]
显示给定目录中的文件。
父目录的ID。默认值：根
--顺序{type，name，id，status，size，created}，-o{type，name，id，status，size，created}
用于排序的字段
--上排方向
输出格式化程序：
输出格式化程序选项
-f{csv，json，table，value，yaml}，--format{csv，json，table，value，yaml}
输出格式，默认为table
-c column，--column column
指定要包含的列，可以重复
json格式化程序：
--noindent是否禁用json缩进
table格式化程序：
--max width<；integer>；
最大显示宽度，<；1禁用。您也可以使用
cliff_max_term_width环境变量，但
参数优先。
--fit width使表格适合显示宽度。隐含if--max-
宽度大于0。将环境变量
cliff_fit_width=1设置为始终启用
--如果没有要显示的数据，则打印空的打印空表。
要检索cosmosid中存储的文件（示例），只需运行带有"files"子命令的
``cosmosid``命令。例如：
…代码：：shell
AME具有/不具有顺序方向
cosmosid files--parent<；folder-id>；--order size--up
上载文件
~~~~~~~~~~~~
cosmosid cli支持将示例文件上载到cosmosid中进行
分析。cosmosid支持以下文件类型：*.fastq、.fasta、.fas、
.fa、.seq、.fsa、.fq、.fna、.gz*
cosmosid支持以下类型的分析：\*元基因组学。\*amplicon-16s（目前只支持16s）
注意：您可以获得每个命令和
mcosmosid cli参数的使用帮助，以便只运行nig``cosmosid--help``或
``cosmosid<；command>；--help``
以将示例文件上载到cosmosid，请运行h
``upload``子命令。默认情况下，示例将上载到根文件夹中。要将样本上载到特定的*现有*文件夹中，必须使用文件夹的ID作为参数。
…代码：：shell
将文件放入特定文件夹进行Amplicon 16s分析ss将自动开始。您可以在页面上检查元基因组分析的结果
`CosmoSid Samples`
Amplicon分析结果目前只能从CosmoSid CLI获得。
检索分析结果
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
检索CosmoSid S中指定文件的分析结果隐含run
``cosmosid``命令和``analysis``子命令。例如：
…代码：：shell
>；--已创建订单--Up
注：Amplicon 16S样品没有分析结果。使用报表生成
而不是获取Amplicon 16s的分析列表
a
给定的文件。
要使用tsv文件检索分析报告存档，请运行带有"reports"子命令的
``cosmosid``命令。\`\`\` shell创建
分析报告存档并将其保存在当前目录中，名称
与cosmosid cosmosid reports中的文件名等效–id
创建分析报告存档并将其保存到给定目录中===================================================================================
>创建分析报告存档并将其保存到给定的本地文件中
================================================================================================================……_ cosmosid示例：https://app.cosmosid.com/samples
…_ COSMOSID配置文件页面：https://app.cosmosid.com/settings
=====
用于与cosmosid api交互的命令行界面（cli）和python 3客户端库。
>仅适用于python3，python 2.7尚不支持。
>要求
>操作包
~~~~~~~~~~~
>-python3-python3-pip
>python 3-python包
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>-boto3
-cli是的安装
==
此包提供：\*核心python 3客户端库；\*一个简单的cli
用于与使用核心库的cosmosid交互；
基本安装
----
3’。\*
只需从控制台"sudo pip3 install cosmosid_cli"运行
注意：pip3和setuptools应升级到最新版本。
在安装cosmosid cli之前，请更新工作站上有关
操作系统更新过程的软件包。
。代码：：shell
例如，对于ubuntu 14.04，执行以下步骤：
$sudo apt get update
$sudo apt get upgrade
$sudo-h pip3 install-u pip setuptools
离子。代码：：shell
$sudo-h pip3 install--upgrade cosmosid_cli
要通过cosmosid api密钥自动进行身份验证，您应该创建
凭据文件` ~/.cosmosid``并将您的api密钥以以下格式存储在其中：
。代码：：json
{"api_key"："<；您的api密钥字符串"}
您可以直接使用cosmosid api密钥，而不是将其存储在
凭据文件中。要使用api密钥身份验证，请将密钥作为
参数传递给"cosmosid"命令：
。代码：：shell
cosmosid--api_key=your_api_key<；command>；
cosmosid cli\*1支持多种类型的命令。用于从COSMOSID云检索数据到终端（输出）的命令-文件，分析。\*2。用于将元基因组或扩增子样本上载到用于分析的Cosmosid云的命令-上载。\*3。用于从cosmosid cloud检索报告存档的命令-reports
注意：每个命令都有选项。要获取每个cosmosid cli
命令的使用信息，用户只需运行``cosmosid<；command>；--help``
>检索文件
~~~~~~~~~~~~~~~~
>检索数据的命令具有输出格式选项。用户可以以不同的格式（csv、json、table、value、yaml（table是默认值）将数据输入终端（或其他输出），并指定要显示的列。另外还有csv格式选项，用户可以引用
或不引用或部分引用输出值-all、minimal、none、non-numeric（默认情况下只引用非数值）
代码：：shell
$cosmosid files--help
用法：cosmosid files[-h[-f{csv，json，table，value，yaml}[-c column]
[-noindent][--max width<；integer>；][--fit width]
[-print empty][--quote{all，minimal，none，nonnumeric}
[--parent parent]
[--order{type，name，id，status，size，created}[--up]
显示给定目录中的文件。
父目录的ID。默认值：根
--顺序{type，name，id，status，size，created}，-o{type，name，id，status，size，created}
用于排序的字段
--上排方向
输出格式化程序：
输出格式化程序选项
-f{csv，json，table，value，yaml}，--format{csv，json，table，value，yaml}
输出格式，默认为table
-c column，--column column
指定要包含的列，可以重复
json格式化程序：
--noindent是否禁用json缩进
table格式化程序：
--max width<；integer>；
最大显示宽度，<；1禁用。您也可以使用
cliff_max_term_width环境变量，但
参数优先。
--fit width使表格适合显示宽度。隐含if--max-
宽度大于0。将环境变量
cliff_fit_width=1设置为始终启用
--如果没有要显示的数据，则打印空的打印空表。
要检索cosmosid中存储的文件（示例），只需运行带有"files"子命令的
``cosmosid``命令。例如：
…代码：：shell
AME具有/不具有顺序方向
cosmosid files--parent<；folder-id>；--order size--up
上载文件
~~~~~~~~~~~~
cosmosid cli支持将示例文件上载到cosmosid中进行
分析。cosmosid支持以下文件类型：*.fastq、.fasta、.fas、
.fa、.seq、.fsa、.fq、.fna、.gz*
cosmosid支持以下类型的分析：\*元基因组学。\*amplicon-16s（目前只支持16s）
注意：您可以获得每个命令和
mcosmosid cli参数的使用帮助，以便只运行nig``cosmosid--help``或
``cosmosid<；command>；--help``
以将示例文件上载到cosmosid，请运行h
``upload``子命令。默认情况下，示例将上载到根文件夹中。要将样本上载到特定的*现有*文件夹中，必须使用文件夹的ID作为参数。
…代码：：shell
将文件放入特定文件夹进行Amplicon 16s分析ss将自动开始。您可以在页面上检查元基因组分析的结果
`CosmoSid Samples`
Amplicon分析结果目前只能从CosmoSid CLI获得。
检索分析结果
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
检索CosmoSid S中指定文件的分析结果隐含run
``cosmosid``命令和``analysis``子命令。例如：
…代码：：shell
>；--已创建订单--Up
注：Amplicon 16S样品没有分析结果。使用报表生成
而不是获取Amplicon 16s的分析列表
a
给定的文件。
要使用tsv文件检索分析报告存档，请运行带有"reports"子命令的
``cosmosid``命令。\`\`\` shell创建
分析报告存档并将其保存在当前目录中，名称
与cosmosid cosmosid reports中的文件名等效–id
创建分析报告存档并将其保存到给定目录中===================================================================================
>创建分析报告存档并将其保存到给定的本地文件中
================================================================================================================……_ cosmosid示例：https://app.cosmosid.com/samples
…_ COSMOSID配置文件页面：https://app.cosmosid.com/settings
欢迎加入QQ群-->： 979659372
