diff --git a/CHANGELOG.rst b/CHANGELOG.rst index d8eba296..49fb2a1a 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,14 @@ Changelog ========== +.. _2.7.1: + +2.7.1 - 2024-06-27 +~~~~~~~~~~~~~~~~~~~ +- Fixes: + - Mismatch in the executable name in the documentation fixed. + + .. _2.7.0: 2.7.0 - 2024-05-29 diff --git a/SPRINTLOG.md b/SPRINTLOG.md index d86651ed..4b6f5279 100644 --- a/SPRINTLOG.md +++ b/SPRINTLOG.md @@ -356,3 +356,7 @@ _Empty sprint_ - Update docs for Testing instance migration, including removing use of 'dev' ([#691](https://github.com/ScilifelabDataCentre/dds_cli/pull/691)) - Fix GitHub Pages action, that broke due to update in the action's image ([#695](https://github.com/ScilifelabDataCentre/dds_cli/pull/695)) - Fix Action that builds the executable files due to update in MacOs default architecture ([#700](https://github.com/ScilifelabDataCentre/dds_cli/pull/700) + +# 2024-06-17 - 2024-06-28 + +- Update documentation to have correct executable name ([#702](https://github.com/ScilifelabDataCentre/dds_cli/pull/702)) diff --git a/dds_cli/version.py b/dds_cli/version.py index 4253692c..f5e94b47 100644 --- a/dds_cli/version.py +++ b/dds_cli/version.py @@ -2,4 +2,4 @@ # Do not change bump the major version unless absolutely necessary - makes incompatible with API # If mid or minor version reaches 9, continue to 10, 11 etc. -__version__ = "2.7.0" +__version__ = "2.7.1" diff --git a/docs/installation.rst b/docs/installation.rst index 7d06be79..b7162ce4 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -85,13 +85,13 @@ Install via the **executable** .. code-block:: bash - $ chmod +x dds-cli_ubuntu_x86_64 + $ chmod +x dds_cli_ubuntu_x86_64 * On MacOS: .. code-block:: bash - $ chmod +x dds-cli_macos_x86_64 + $ chmod +x dds_cli_macos_x86_64 3. Test that the ``dds-cli`` command works by running the following: diff --git a/img/dds-help-1.svg b/img/dds-help-1.svg index 61db45bc..7b0b6614 100644 --- a/img/dds-help-1.svg +++ b/img/dds-help-1.svg @@ -19,140 +19,140 @@ font-weight: 700; } - .terminal-3455700917-matrix { + .terminal-4202155958-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3455700917-title { + .terminal-4202155958-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3455700917-r1 { fill: #c5c8c6 } -.terminal-3455700917-r2 { fill: #868887;font-style: italic; } -.terminal-3455700917-r3 { fill: #c5c8c6;font-weight: bold } -.terminal-3455700917-r4 { fill: #d0b344;font-weight: bold } -.terminal-3455700917-r5 { fill: #68a0b3;font-weight: bold } -.terminal-3455700917-r6 { fill: #868887 } -.terminal-3455700917-r7 { fill: #4e707b;font-weight: bold } -.terminal-3455700917-r8 { fill: #98a84b;font-weight: bold } -.terminal-3455700917-r9 { fill: #8d7b39;font-weight: bold } + .terminal-4202155958-r1 { fill: #c5c8c6 } +.terminal-4202155958-r2 { fill: #868887;font-style: italic; } +.terminal-4202155958-r3 { fill: #c5c8c6;font-weight: bold } +.terminal-4202155958-r4 { fill: #d0b344;font-weight: bold } +.terminal-4202155958-r5 { fill: #68a0b3;font-weight: bold } +.terminal-4202155958-r6 { fill: #868887 } +.terminal-4202155958-r7 { fill: #4e707b;font-weight: bold } +.terminal-4202155958-r8 { fill: #98a84b;font-weight: bold } +.terminal-4202155958-r9 { fill: #8d7b39;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -164,46 +164,46 @@ - + - - $ dds -     ︵  - ︵ (  )   ︵  -(  ) ) (  (  )   SciLifeLab Data Delivery System  - ︶  (  ) ) (    https://delivery.scilifelab.se/  -      ︶ (  )    CLI Version 2.7.0  -          ︶ -[..truncated..] -Usage: dds [OPTIONS] COMMAND [ARGS]... - - SciLifeLab Data Delivery System (DDS) command line interface.                                       -Access token is saved in a .dds_cli_token file in the home directory. -The token is valid for 7 days. Make sure your token is valid long enough for the delivery to  -finish. To avoid that a delivery fails because of an expired token, we recommend reauthenticating  -yourself before each delivery ('dds data put' / 'get'). - -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ -│--verbose-v  Print verbose output to the console.                              │ -│--log-file-l<filename>  Save a log to a file.                                             │ -│--no-prompt  Run without any interactive features.                             │ -│--token-path-tpTEXT        The path where the authentication token will be stored. For a     │ -│                                normal use-case, this should not be needed.                       │ -│--version  Display the version of this software.                             │ -│--help  List the options of any DDS subcommand and its default settings.  │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮ -│auth         Group command for creating and managing authenticated sessions (valid for 7 days). │ -│data         Group command for uploading, downloading and managing project data.                │ -│ls           List the active projects you have access to or the project contents.               │ -│maintenance  [Super Admins only] Activate / Deactivate / Display status for Maintenance mode.   │ -│motd         [Super Admins only] Group command for managing Message of the Day within DDS.      │ -│project      Group command for creating and managing projects within the DDS.                   │ -│stats        Get statistics in the DDS.                                                         │ -│unit         [Super Admins only] Group command for managing units.                              │ -│user         Group command for managing user accounts, including your own.                      │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + $ dds +     ︵  + ︵ (  )   ︵  +(  ) ) (  (  )   SciLifeLab Data Delivery System  + ︶  (  ) ) (    https://delivery.scilifelab.se/  +      ︶ (  )    CLI Version 2.7.1  +          ︶ +[..truncated..] +Usage: dds [OPTIONS] COMMAND [ARGS]... + + SciLifeLab Data Delivery System (DDS) command line interface.                                       +Access token is saved in a .dds_cli_token file in the home directory. +The token is valid for 7 days. Make sure your token is valid long enough for the delivery to  +finish. To avoid that a delivery fails because of an expired token, we recommend reauthenticating  +yourself before each delivery ('dds data put' / 'get'). + +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-v  Print verbose output to the console.                              │ +│--log-file-l<filename>  Save a log to a file.                                             │ +│--no-prompt  Run without any interactive features.                             │ +│--token-path-tpTEXT        The path where the authentication token will be stored. For a     │ +│                                normal use-case, this should not be needed.                       │ +│--version  Display the version of this software.                             │ +│--help  List the options of any DDS subcommand and its default settings.  │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮ +│auth         Group command for creating and managing authenticated sessions (valid for 7 days). │ +│data         Group command for uploading, downloading and managing project data.                │ +│ls           List the active projects you have access to or the project contents.               │ +│maintenance  [Super Admins only] Activate / Deactivate / Display status for Maintenance mode.   │ +│motd         [Super Admins only] Group command for managing Message of the Day within DDS.      │ +│project      Group command for creating and managing projects within the DDS.                   │ +│stats        Get statistics in the DDS.                                                         │ +│unit         [Super Admins only] Group command for managing units.                              │ +│user         Group command for managing user accounts, including your own.                      │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ + diff --git a/img/dds-help-2.svg b/img/dds-help-2.svg index 639213a6..c06b5117 100644 --- a/img/dds-help-2.svg +++ b/img/dds-help-2.svg @@ -19,140 +19,140 @@ font-weight: 700; } - .terminal-1581765080-matrix { + .terminal-2328220121-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1581765080-title { + .terminal-2328220121-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1581765080-r1 { fill: #c5c8c6 } -.terminal-1581765080-r2 { fill: #868887;font-style: italic; } -.terminal-1581765080-r3 { fill: #c5c8c6;font-weight: bold } -.terminal-1581765080-r4 { fill: #d0b344;font-weight: bold } -.terminal-1581765080-r5 { fill: #68a0b3;font-weight: bold } -.terminal-1581765080-r6 { fill: #868887 } -.terminal-1581765080-r7 { fill: #4e707b;font-weight: bold } -.terminal-1581765080-r8 { fill: #98a84b;font-weight: bold } -.terminal-1581765080-r9 { fill: #8d7b39;font-weight: bold } + .terminal-2328220121-r1 { fill: #c5c8c6 } +.terminal-2328220121-r2 { fill: #868887;font-style: italic; } +.terminal-2328220121-r3 { fill: #c5c8c6;font-weight: bold } +.terminal-2328220121-r4 { fill: #d0b344;font-weight: bold } +.terminal-2328220121-r5 { fill: #68a0b3;font-weight: bold } +.terminal-2328220121-r6 { fill: #868887 } +.terminal-2328220121-r7 { fill: #4e707b;font-weight: bold } +.terminal-2328220121-r8 { fill: #98a84b;font-weight: bold } +.terminal-2328220121-r9 { fill: #8d7b39;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -164,46 +164,46 @@ - + - - $ dds --help -     ︵  - ︵ (  )   ︵  -(  ) ) (  (  )   SciLifeLab Data Delivery System  - ︶  (  ) ) (    https://delivery.scilifelab.se/  -      ︶ (  )    CLI Version 2.7.0  -          ︶ -[..truncated..] -Usage: dds [OPTIONS] COMMAND [ARGS]... - - SciLifeLab Data Delivery System (DDS) command line interface.                                       -Access token is saved in a .dds_cli_token file in the home directory. -The token is valid for 7 days. Make sure your token is valid long enough for the delivery to  -finish. To avoid that a delivery fails because of an expired token, we recommend reauthenticating  -yourself before each delivery ('dds data put' / 'get'). - -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ -│--verbose-v  Print verbose output to the console.                              │ -│--log-file-l<filename>  Save a log to a file.                                             │ -│--no-prompt  Run without any interactive features.                             │ -│--token-path-tpTEXT        The path where the authentication token will be stored. For a     │ -│                                normal use-case, this should not be needed.                       │ -│--version  Display the version of this software.                             │ -│--help  List the options of any DDS subcommand and its default settings.  │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮ -│auth         Group command for creating and managing authenticated sessions (valid for 7 days). │ -│data         Group command for uploading, downloading and managing project data.                │ -│ls           List the active projects you have access to or the project contents.               │ -│maintenance  [Super Admins only] Activate / Deactivate / Display status for Maintenance mode.   │ -│motd         [Super Admins only] Group command for managing Message of the Day within DDS.      │ -│project      Group command for creating and managing projects within the DDS.                   │ -│stats        Get statistics in the DDS.                                                         │ -│unit         [Super Admins only] Group command for managing units.                              │ -│user         Group command for managing user accounts, including your own.                      │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + $ dds --help +     ︵  + ︵ (  )   ︵  +(  ) ) (  (  )   SciLifeLab Data Delivery System  + ︶  (  ) ) (    https://delivery.scilifelab.se/  +      ︶ (  )    CLI Version 2.7.1  +          ︶ +[..truncated..] +Usage: dds [OPTIONS] COMMAND [ARGS]... + + SciLifeLab Data Delivery System (DDS) command line interface.                                       +Access token is saved in a .dds_cli_token file in the home directory. +The token is valid for 7 days. Make sure your token is valid long enough for the delivery to  +finish. To avoid that a delivery fails because of an expired token, we recommend reauthenticating  +yourself before each delivery ('dds data put' / 'get'). + +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-v  Print verbose output to the console.                              │ +│--log-file-l<filename>  Save a log to a file.                                             │ +│--no-prompt  Run without any interactive features.                             │ +│--token-path-tpTEXT        The path where the authentication token will be stored. For a     │ +│                                normal use-case, this should not be needed.                       │ +│--version  Display the version of this software.                             │ +│--help  List the options of any DDS subcommand and its default settings.  │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮ +│auth         Group command for creating and managing authenticated sessions (valid for 7 days). │ +│data         Group command for uploading, downloading and managing project data.                │ +│ls           List the active projects you have access to or the project contents.               │ +│maintenance  [Super Admins only] Activate / Deactivate / Display status for Maintenance mode.   │ +│motd         [Super Admins only] Group command for managing Message of the Day within DDS.      │ +│project      Group command for creating and managing projects within the DDS.                   │ +│stats        Get statistics in the DDS.                                                         │ +│unit         [Super Admins only] Group command for managing units.                              │ +│user         Group command for managing user accounts, including your own.                      │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ + diff --git a/img/dds-version.svg b/img/dds-version.svg index 75b858cc..ef588e31 100644 --- a/img/dds-version.svg +++ b/img/dds-version.svg @@ -19,31 +19,31 @@ font-weight: 700; } - .terminal-1540634514-matrix { + .terminal-1541683091-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1540634514-title { + .terminal-1541683091-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1540634514-r1 { fill: #c5c8c6 } -.terminal-1540634514-r2 { fill: #868887;font-style: italic; } + .terminal-1541683091-r1 { fill: #c5c8c6 } +.terminal-1541683091-r2 { fill: #868887;font-style: italic; } - + - + - + @@ -55,12 +55,12 @@ - + - - $ dds --version -[..truncated..] -Data Delivery System, version 2.7.0 + + $ dds --version +[..truncated..] +Data Delivery System, version 2.7.1 diff --git a/img/python-version.svg b/img/python-version.svg index 32066b50..5206579e 100644 --- a/img/python-version.svg +++ b/img/python-version.svg @@ -19,27 +19,27 @@ font-weight: 700; } - .terminal-624105866-matrix { + .terminal-625154443-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-624105866-title { + .terminal-625154443-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-624105866-r1 { fill: #c5c8c6 } + .terminal-625154443-r1 { fill: #c5c8c6 } - + - + @@ -51,11 +51,11 @@ - + - - $ python --version -Python 3.12.3 + + $ python --version +Python 3.12.4 diff --git a/img/python3-version.svg b/img/python3-version.svg index d2d71782..fbb94e36 100644 --- a/img/python3-version.svg +++ b/img/python3-version.svg @@ -19,27 +19,27 @@ font-weight: 700; } - .terminal-935926205-matrix { + .terminal-936974782-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-935926205-title { + .terminal-936974782-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-935926205-r1 { fill: #c5c8c6 } + .terminal-936974782-r1 { fill: #c5c8c6 } - + - + @@ -51,11 +51,11 @@ - + - - $ python3 --version -Python 3.12.3 + + $ python3 --version +Python 3.12.4