Provide documentation for the pulp-cli plugin

[mikalstill]

It would be nice to not have to make raw HTTP calls to manage repositories. This PR at the moment is just a minimal implementation of creating a repository, but I wanted to ask how you'd feel about a CLI plugin.

[mdellweg]

https://github.com/pulp/pulp-cli-deb

Please don't duplicate the work. ;)
It's documented there: https://docs.pulpproject.org/pulp_cli/#cli-plugins

[mikalstill]

I didn't even realise this existed. May I ask why the pulp-deb docs use http instead of this CLI?

[quba42]

I didn't even realise this existed. May I ask why the pulp-deb docs use http instead of this CLI?

Because pulp-cli-deb did not exist at the time the docs were written (and also pulp-cli-deb is not as fully feature full as the CLI for some of the other plugins). Adding docs about pulp-cli-deb is definitely wanted, but nobody has time to work on them. 😞

[quba42]

I guess it might be worth making it a priority to add at least some minimal docs to inform users that pulp-cli-deb exists.

[mikalstill]

Thanks for the reply. I'm happy enough to pivot this PR into being tweaks to the docs pointing at the exist CLI plugin. Do I need to create an issue for that before updating this PR?

[quba42]

Do I need to create an issue for that before updating this PR?

I went ahead and created one you can use: #598

[mikalstill]

Questions and comments from a first pass at this:

• is it just me, or is it a bit clumbersome that the CLI plugin returns JSON blocks that a user then needs to parse?
• there are obvious gaps for sync / upload in the CLI plugin.

[quba42]

• is it just me, or is it a bit clumbersome that the CLI plugin returns JSON blocks that a user then needs to parse?

AFAIK this is exactly the same as for Pulp CLI for any other Pulp plugin like pulp_rpm, though I believe it is also configurable:

# pulp config create --help
  --format [json|yaml|none]       Format of the response

Never tried any of the other formats, so I have no idea if they are more or less convenient.

• there are obvious gaps for sync / upload in the CLI plugin.

I am not aware of any gaps for sync, but there are certainly known feature gaps including for upload: https://github.com/pulp/pulp-cli-deb/issues

[stale]

This pull request has been marked 'stale' due to lack of recent activity. If there is no further activity, the PR will be closed in another 30 days. Thank you for your contribution!

[stale]

This issue is no longer marked for closure.

[stale]

This pull request has been marked 'stale' due to lack of recent activity. If there is no further activity, the PR will be closed in another 30 days. Thank you for your contribution!

[mdellweg]

Please do not use sudo pip. Talk about a virtual env if you like...

[stale]

This pull request has been marked 'stale' due to lack of recent activity. If there is no further activity, the PR will be closed in another 30 days. Thank you for your contribution!

[quba42]

Note that we will now be adding Pulp CLI workflows for the pulp_deb 3.0 release: #876