annotate README.rst @ 12:70900c25b43b draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit b9c33a82f739ebd40651bb7acfc1264208cea83c
author iuc
date Mon, 26 May 2025 10:03:21 +0000
parents e7995727674f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
1 ENA-upload-cli wrapper
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
2 ======================
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
3
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
4 Galaxy wrapper of the
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
5 `ena-upload-cli <https://github.com/usegalaxy-eu/ena-upload-cli>`__.
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
6 Templates that can be used in as input for the metadata can be found
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
7 `here <https://github.com/ELIXIR-Belgium/ENA-metadata-templates>`__
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
8
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
9 This tool is shipped in a ready to use Galaxy container found
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
10 `here <https://github.com/ELIXIR-Belgium/ena-upload-container>`__.
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
11
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
12 Setting up credentials on Galaxy
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
13 --------------------------------
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
14
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
15 The admin of the server can set up global credentials through a file
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
16 with the format:
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
17
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
18 .. code-block:: yaml
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
19
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
20 username: webin_id
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
21 password: webin_password
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
22
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
23 The path to this file must be exported as an environment variable called
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
24 $GALAXY_ENA_SECRETS
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
25
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
26 Alternatively, the admin can enable users to set their own credentials
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
27 for this tool. To enable it, make sure the file
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
28 ``config/user_preferences_extra_conf.yml`` has the following section:
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
29
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
30 .. code-block:: yaml
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
31
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
32 ena_webin_account:
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
33 description: Your ENA Webin account details
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
34 inputs:
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
35 - name: webin_id
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
36 label: ENA Webin ID
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
37 type: text
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
38 required: False
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
39 - name: password
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
40 label: Password
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
41 type: password
e7995727674f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ena_upload commit 6428c6a64979e4a1f745066a62280e38ad98d249
iuc
parents:
diff changeset
42 required: False