annotate README.rst @ 3:8a4b0f14aa4e draft default tip

planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit 62cfda2672d51d769c18c633cb57a7a71dd5d226
author galaxy-australia
date Wed, 23 Oct 2024 00:10:46 +0000
parents 6d0c0961ae13
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
1 FileSenderCLI wrapper
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
2 ======================
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
3
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
4 Galaxy wrapper of the AARNET
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
5 `filesender <https://support.aarnet.edu.au/hc/en-us/articles/230067927-Send-files-with-FileSender>`__.
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
6
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
7 Setting up credentials on Galaxy
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
8 --------------------------------
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
9
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
10 The admin can enable users to set their own credentials
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
11 for this tool. To enable it, make sure the file
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
12 ``config/user_preferences_extra_conf.yml`` has the following section:
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
13
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
14 .. code-block:: yaml
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
15
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
16 aarnet_filesender_account:
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
17 description: AARNet FileSender Account Info
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
18 inputs:
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
19 - name: username
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
20 label: AARNet FileSender Username
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
21 type: text
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
22 required: False
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
23 - name: apikey
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
24 label: AARNet FileSender API Key
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
25 type: password
6d0c0961ae13 planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
galaxy-australia
parents:
diff changeset
26 required: False