HydrologicEngineeringCenter / HydrologicEngineeringCenter/cwms-cli

Make each command have a specific req'd cwms-python target

Open
#151 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
2
Forks
4
Avg merge
19h 59m
Merged PRs (30d)
3

Description

CLI Script

other

Feature Proposal

I.e.

This

https://github.com/HydrologicEngineeringCenter/cwms-cli/blob/1bedb0fa92e62d69b31199888d5824949b08460a/cwmscli/requirements.py#L5-L11

just gets used on everything via

https://github.com/HydrologicEngineeringCenter/cwms-cli/blob/1bedb0fa92e62d69b31199888d5824949b08460a/cwmscli/commands/commands_cwms.py#L28

Thoughts on me making an issue to remove the global and make those explicit?

i.e.

​@requries(reqs.cwms.set("version", "1.0.3") This would not work

This will make it so a sub command like users can be set to 1.0.3 but the people also wanting to just have it work for another command can have an older version if they don't need to update!

REDACTED relevant log output

Related Context or Links

There's a global dep in the pytoml here

https://github.com/HydrologicEngineeringCenter/cwms-cli/blob/1bedb0fa92e62d69b31199888d5824949b08460a/pyproject.toml#L21

That could also be at a lower minimum required for all of cwms-cli. Although cwms-cli itself does not need cwms-python until you drill down.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading cwmscli/requirements.py and the command definitions in cwmscli/commands/commands_cwms.py, then inspect the global dependency in pyproject.toml. Determine how dependencies are currently applied to every command and how command-specific targets could be represented. Done means commands declare their required cwms-python versions explicitly while the global minimum remains appropriate for the CLI.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.