annotate README.rst @ 12:29648e5e83a8 draft

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