Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose Elara's version via the CLI #213

Open
mfitz opened this issue Jul 15, 2022 · 0 comments
Open

Expose Elara's version via the CLI #213

mfitz opened this issue Jul 15, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@mfitz
Copy link
Contributor

mfitz commented Jul 15, 2022

Elara's CLI currently exposes the following subcommands:

Usage: elara [OPTIONS] COMMAND [ARGS]...

  Command line tool for processing a MATSim scenario events output.

Options:
  --help  Show this message and exit.

Commands:
  run              Run Elara using a config.
  event-handlers   Access event handler output group.
  plan-handlers    Access plan handler output group.
  post-processors  Access post processing output group.

We should add a version subcommand, and/or support for elara --version/elara -v, as a way to report the version number, which we currently record in the elara/init.py module, although it seems to be neglected.

Adding support for displaying the version via the CLI will also drive better and more organised/formalised versioning and release behaviour in general, including semantic versioning, a well maintained change log, and tagged releases with release notes on GitHub.

Once we are on top of versioning, we could also subsequently add a feature or extend the version subcommand such that Elara checks your local version and prints a message to console if a newer version is available. That would be covered by a separate issue to which this issue would be a precursor.

@mfitz mfitz added enhancement New feature or request good first issue Good for newcomers labels Jul 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant