annotate README.rst @ 0:c9f87770ba8f draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
author iuc
date Tue, 05 Aug 2025 11:53:57 +0000
parents
children 361a6693aa25
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
1 Webin CLI wrapper
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
2 ======================
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
3 the submission of genome assemblies using the
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
4 [Webin-cli](https://github.com/enasequence/webin-cli)
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
5
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
6 This is a Galaxy wrapper for `webin cli <https://github.com/enasequence/webin-cli>`__ tool from `ENA <https://www.ebi.ac.uk/ena/browser/home>`__.
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
7
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
8
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
9 Setting up credentials on Galaxy
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
10 --------------------------------
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
11
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
12 The admin of the server can set up global credentials through a file
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
13 with the format:
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
14
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
15 .. code-block:: yaml
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
16
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
17 username: webin_id
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
18 password: webin_password
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
19
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
20 The path to this file must be exported as an environment variable called
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
21 $GALAXY_ENA_SECRETS
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
22
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
23 Alternatively, the admin can enable users to set their own credentials
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
24 for this tool. To enable it, make sure the file
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
25 ``config/user_preferences_extra_conf.yml`` has the following section:
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
26
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
27 .. code-block:: yaml
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
28
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
29 ena_webin_account:
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
30 description: Your ENA Webin account details
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
31 inputs:
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
32 - name: webin_id
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
33 label: ENA Webin ID
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
34 type: text
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
35 required: False
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
36 - name: password
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
37 label: Password
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
38 type: password
c9f87770ba8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/ena_webin_cli commit 35b4a063e227ea4a2440e23c4df5c27e42c077cb
iuc
parents:
diff changeset
39 required: False