deposit.cli: Align cli like other modules + update documentation
ClosedPublic
Actions

Authored by ardumont on Mar 12 2019, 9:52 PM.

Details

Reviewers

douardda

Group Reviewers

Reviewers

Commits

Summary

swh.deposit.cli: Migrate client command as main cli subcommand
Allow auto-completion to work (Add eval "$(_SWH_DEPOSIT_COMPLETE=$autocomplete_cmd swh-deposit)" in $VIRTUAL_ENV/bin/postactivate)
Allow to use --config-file to pass extra config file
Update documentation accordingly

Related T1580

Test Plan

tox

Repository

rDDEP Push deposit

Branch

master

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

ardumont marked an inline comment as done.Mar 12 2019, 10:03 PM

ardumont added inline comments.

swh/deposit/cli.py
449	In real life, what do our users need to do to have completion? Do they need to add something in the .*shrc configuration (like the eval instruction we add to our virtual env postactivate script)?

I think the subcommand should be named "deposit" instead of "client", because what matters is what it does, not what it is.

swh/deposit/cli.py
449	https://forge.softwareheritage.org/source/swh-docker-dev/#make-your-life-a-bit-eas

I think the subcommand should be named "deposit" instead of "client", because what matters is what it does, not what it is.

that makes sense, thanks.

I kept client solely because the previous cli (i migrated that code from) was dubbed 'swh.deposit.client.cli'...

swh/deposit/cli.py
449	yes, that's what i was referring to by `like the eval instruction we add to our virtual env postactivate script` ;) So i'm guessing that you confirm that they need to add something similar in their *shrc routine.