Unified CLI

[pgierz]

Cleans up the CLI for a more unified experience:

Feature List

• All programs start with esm-tools <command>
• Beautiful colours
• Old commands still work as expected

To consider

• question Further information is requested Version and model are combined by minus. Maybe adopt a spack-like syntax?

Test

• esm-tools get fesom-2.5 (Note: no added minus, the subcommand is just get)
• esm-tools comp fesom-2.5
• esm-tools install fesom-2.5
• esm-tools run ...

[pgierz]

Incomplete, but here is a preview:

[pgierz]

This PR includes continuous integration label, since there is a new CI step specifically for the new syntax, e.g.:

$ esm-tools get <model>

[pgierz]

Almost done, just need meta-commands inside esm-master.

[pgierz]

Copilot Summary

This pull request includes several key changes to the esm-tools project, focusing on adding new CLI tests, updating dependencies, and refactoring CLI scripts to use rich-click for improved command-line interfaces.

CI/CD Improvements:

• Added a new GitHub Actions workflow for testing the new CLI (.github/workflows/new-cli.yml).

Dependency Updates:

• Updated setup.py to include new dependencies: rich-click and click-repl and restructured the console_scripts entry points. [1] [2] [3]

CLI Refactoring:

• Refactored multiple CLI scripts to use rich-click for enhanced command-line interfaces:
  • src/esm_archiving/cli.py
  • src/esm_cleanup/cli.py
  • src/esm_database/cli.py
  • src/esm_master/cli.py
  • src/esm_master/cli-broken.py

Code Clean-Up:

• Removed unused imports from setup.py and other minor code clean-ups. [1] [2]

These changes enhance the project's maintainability and user experience by improving the CLI's usability and ensuring the CI/CD pipeline tests the new CLI functionality.

[JanStreffing]

I don't see esm-master clean and recomp there. Has something changed in this regard?

Edit: In the second picture there is clean, but no recomp or install, which it seems are on your radar.

[pgierz]

That is in there now, here is an up-to-date version:

Feel free to try it out and give feedback.

NOTE You need to install with pip install . (not in editable mode, I still need to fix that)

[pgierz]

Todo: symlinks for configs, namelists, etc

[pgierz]

@mandresm I am not sure if the setup.py still needs to be adapted to get the right paths. You worked on that more recently than I did, maybe you can have a look?

[seb-wahl]

Something that you/we should definitely check if the updated works correctly from an existing installation i.e. that the move of namelists folder and the symlinking afterwards works as expected.