Skip to content

Commit

Permalink
update the uploading helper message
Browse files Browse the repository at this point in the history
  • Loading branch information
zhiren committed Dec 12, 2023
1 parent ae74b14 commit 1e742bf
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
6 changes: 3 additions & 3 deletions app/commands/file.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def cli():
@click.option(
'-m',
'--upload-message',
default='',
default=None,
required=False,
help=file_help.file_help_page(file_help.FileHELP.FILE_UPLOAD_M),
show_default=True,
Expand All @@ -103,15 +103,15 @@ def cli():
'-td',
default=1,
required=False,
help='The number of thread for upload a file',
help='The number of threads for uploading a file.',
show_default=True,
)
@click.option(
'--output-path',
'-o',
default='./manifest.json',
required=False,
help='The output path for the manifest file of resumable upload',
help='The output path for the manifest file of resumable upload.',
show_default=True,
)
@doc(file_help.file_help_page(file_help.FileHELP.FILE_UPLOAD))
Expand Down
19 changes: 10 additions & 9 deletions app/resources/custom_help.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,25 +37,26 @@ class HelpPage:
'FILE_SYNC': 'Download files/folders from a given Project/folder/file in core zone.',
'FILE_UPLOAD': 'Upload files/folders to a given Project path.',
'FILE_RESUME': 'Resume the upload process with given manifest file.',
'FILE_Z': 'Target Zone (i.e., core/greenroom) [default: greenroom]',
'FILE_Z': 'Target Zone (i.e., core/greenroom).',
'FILE_ATTRIBUTE_P': 'Project Code',
'FILE_ATTRIBUTE_N': 'Attribute Template Name',
'FILE_SYNC_ZIP': 'Download files as a zip.',
'FILE_SYNC_I': 'Enable downloading by geid.',
'FILE_SYNC_Z': 'Target Zone (i.e., core/greenroom)',
'FILE_UPLOAD_P': 'Project folder path starting from Project code. (i.e., indoctestproject/user/folder)',
'FILE_UPLOAD_A': 'File Attribute Template used for annotating files during upload.',
'FILE_UPLOAD_T': (
'Add a tag to the file. This option could be used multiple times for adding multiple tags.'
'FILE_SYNC_Z': 'Target Zone (i.e., core/greenroom).',
'FILE_UPLOAD_P': 'Project folder path starting from Project Code. (i.e., indoctestproject/user/folder)',
'FILE_UPLOAD_A': 'Add attributes to the file using a File Attribute Template.',
'FILE_UPLOAD_T': 'Add tags to the file using a Tag file.',
'FILE_UPLOAD_M': 'The message used to comment on the purpose of uploading your processed file.',
'FILE_UPLOAD_S': (
'Project file path for identifying a source file when creating an upstream '
'file lineage node. Source files must exist in the Core zone.'
),
'FILE_UPLOAD_M': 'The message used to comment on the purpose of uploading your processed file',
'FILE_UPLOAD_S': 'The Project path of the source file of your processed files.',
'FILE_UPLOAD_PIPELINE': (
"The processed pipeline of your processed files. [only used with '--source' option]"
),
'FILE_UPLOAD_ZIP': 'Upload folder as a compressed zip file.',
'FILE_META': 'Download metadata file of a given file in target zone.',
'FILE_META_Z': 'Target Zone (i.e., core/greenroom)',
'FILE_META_Z': 'Target Zone (i.e., core/greenroom).',
'FILE_META_G': 'The location of general metadata file',
'FILE_META_A': 'The location of attribute metadata file',
'FILE_META_T': 'The location of tag metadata file',
Expand Down

1 comment on commit 1e742bf

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
__init__.py00100% 
pilotcli.py0310%5, 7–8, 10–14, 17–21, 23–28, 31–39, 42–44
commands
   __init__.py00100% 
   container_registry.py01959%16, 22–24, 31–33, 41–44, 50–53, 62–65
   dataset.py04844%19, 36–38, 41–48, 50–60, 78–80, 83–91, 93–103, 123, 127
   entry_point.py01085%38, 44, 87–89, 91–95
   file.py04181%38, 135, 144–146, 150, 155, 158–160, 177–178, 220, 301–308, 310, 312, 326–332, 334, 363, 365, 368, 414, 417, 434–436, 442–443
   project.py0197%17
   user.py0685%23, 40, 48, 56, 72–73
configs
   __init__.py00100% 
   app_config.py00100% 
   config.py00100% 
   user_config.py01784%61, 70, 114, 124, 131, 135, 139, 143, 147, 151, 155, 159, 163, 167, 171, 175, 179
models
   __init__.py00100% 
   enums.py00100% 
   service_meta_class.py0180%9
   singleton.py00100% 
   upload_form.py0625%30, 42–46
resources
   custom_error.py00100% 
   custom_help.py00100% 
services
   __init__.py00100% 
services/container_registry_manager
   container_registry_manager.py010817%19–20, 23–26, 29–33, 36–44, 48–60, 62–64, 68–82, 84–86, 90–99, 101–103, 107–110, 125–136, 140–143, 147–162, 164, 166–169
services/crypto
   __init__.py00100% 
   crypto.py01940%35, 43–47, 49, 59–61, 69–75, 77, 79
services/dataset_manager
   dataset_detail.py02370%42, 44, 61, 68–73, 75–77, 79–88, 90
   dataset_download.py01983%56, 72–73, 84, 96, 98–99, 101–102, 104, 106–108, 116–119, 153, 165
   dataset_list.py0878%37, 43–46, 48–50
   model.py00100% 
services/file_manager
   __init__.py00100% 
   file_list.py01775%29, 54, 56, 70–72, 80–83, 85, 91–96
   file_manifests.py09525%19–24, 39–43, 47–48, 51–59, 61, 65–68, 71–75, 77, 81–82, 85–87, 91–92, 95–102, 104, 107, 109–110, 112–113, 115–118, 123–129, 134–139, 142–148, 150–152, 155–161, 163–165, 167–170
   file_tag.py03931%23, 27–31, 33, 36–48, 50–52, 54–55, 59–61, 64–68, 70–73, 75–76
services/file_manager/file_download
   __init__.py00100% 
   download_client.py017423%44–45, 47–53, 56–57, 59–60, 69, 71–72, 76–79, 86, 91–94, 96, 98–106, 108, 110, 114–119, 121, 124–125, 128–130, 132–134, 136–137, 139–141, 145–153, 156–161, 165–174, 182–184, 186–193, 195–199, 204–214, 216–217, 220–221, 226–227, 231–236, 240–241, 244–246, 248–259, 263–266, 269–273, 275–277, 279–281, 283–284, 286, 290–292, 294–307, 309
   model.py0187%15
services/file_manager/file_metadata
   __init__.py00100% 
   file_metadata_client.py0395%96–98
services/file_manager/file_upload
   __init__.py00100% 
   exception.py0175%10
   file_upload.py02884%35–42, 99–101, 113, 144–145, 149, 154, 191, 211–213, 254–255, 257–259, 333, 336, 340
   models.py0591%24, 44, 150–152
   upload_client.py07760%101–104, 207–209, 223–229, 231–235, 237–249, 251, 295, 298, 302, 304–306, 308–311, 315–319, 321, 325, 327, 329, 331, 350, 380–381, 386, 390–393, 397, 413, 415–417, 424, 429–430, 432, 434–435, 437–440, 442
   upload_validator.py02156%29–31, 34–39, 42–48, 51–52, 57, 59, 61
services/logger_services
   __init__.py00100% 
   log_functions.py00100% 
services/output_manager
   __init__.py00100% 
   error_handler.py00100% 
   help_page.py00100% 
   message_handler.py05669%23, 45, 50, 65–67, 72, 82, 87, 100, 105, 112, 117, 122, 126, 142, 177, 187, 196, 209, 228, 250–261, 272–277, 279–285, 296, 300–301, 305–306, 308–309, 313, 317, 321
services/project_manager
   __init__.py00100% 
   project.py0878%38, 44–47, 49–51
services/user_authentication
   __init__.py00100% 
   decorator.py0293%27, 30
   token_manager.py0986%26, 41–42, 73, 76, 91, 96, 100, 105
   user_login_logout.py04266%30–31, 41, 122, 126–132, 134–136, 140–141, 145–152, 154–156, 160–161, 168–173, 175–177, 181–184
utils
   __init__.py00100% 
   aggregated.py03766%49, 61, 86–88, 90–91, 98–99, 101, 105–108, 110–111, 125–132, 134–135, 139–146, 148–150
TOTAL295397267% 

Please sign in to comment.