Page MenuHomeSoftware Heritage

Update docs (getting-started, metadata) with latest changes

Authored by ardumont on May 10 2019, 10:18 AM.



And associated discovered caveats along the way...


  • docs/metadata: Change url & external-id from mandatory to optional
  • docs/getting-started: Update according to latest changes


  • deposit.cli: Fix cli no longer displaying result
  • deposit.client: Make sure the error is propagated to client
  • deposit.cli: Allow back partial deposit


  • deposit.cli: Expose a new swh deposit status subcommand
  • deposit.cli.client: Update docstrings
  • cli.client: Improve error message for metadata deposit scenario
  • cli.client: Loosen checks on metadata
  • cli.client: Let click check for filepath existence

Related T1650
Related T1648

Test Plan

tox & docker-dev

Diff Detail

rDDEP Push deposit
Automatic diff as part of commit; lint not applicable.
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

olasd added inline comments.
39 ↗(On Diff #4766)

This should be a reference to an anchor rather than a hardcoded file name.

247 ↗(On Diff #4766)

I found this quite clearer but also allowed to disentangle a little the mess in the parsing function...

To the expense of some more duplication i intend to remove later (when we factor this client out and i finally take the time to take a look at how to test the cli)...


Without this, this no longer displayed anything...
Which i think you warned me a little earlier during the week ;)

This fixed both swh-deposit and swh deposit which were divergent in behavior.

339 ↗(On Diff #4766)

I'm wondering if print would not be better here...
As the output is a dict, today, that gives for example:


whereas a bare dict outputed (with no noise) would be simpler to use for a client wanted to do something with the json-like output.

I guess there is also the formatter configuration route...

What do you think, could print be ok here?

vlorentz added inline comments.

How can ctx.obj not be None?

  • docs: Use anchor instead of hard-coded filename

nvm, got it. What about doing this instead?

log_level = ctx.obj.get('log_level', logging.INFO)

Because, from my understanding of the latest refactoring on cli (swh-core), depending on how you call this, this can be populated.

That's what i meant in my first comment here about the behavior divergence between swh deposit (using swh-core inheritance, i'd expect ctx.obj not none here) and (swh-deposit, no init, i'd expect it to be none).


I tried the second line initially without and that failed.
Probably because of the missing first line which i did not add because of the swh-core 'inheritance' (<~ probably not the right term)...
This is already done there so i don't know the implication of doing it twice... (for that case).

I'll check

Thanks for the heads up.


It works, awesome.
I'll change.

  • deposit.cli: Fix cli no longer displaying result

Better fix suggested by @vlorentz \m/

LGTM but I did not do a very punctilious review

This revision is now accepted and ready to land.May 10 2019, 11:12 AM

Looks great!
small language changes to clarify..

247 ↗(On Diff #4766)

this is a great change!!

74 ↗(On Diff #4770)

I would erase the optionally and explain afterwards that you can omit the software name by adding metadata in the file. for example:

software artifact's name (optional if a metadata filepath is specified and the artifact's name is included in the metadata file).
77 ↗(On Diff #4770)

Same as above:

author's name (optional if a metadata filepath is specified  and the authors are included in the metadata file).
This can be specified multiple times in case of multiple authors.
81 ↗(On Diff #4770)

the client uses for the software object. If not provided, A UUID will be generated by SWH.

37 ↗(On Diff #4770)

erase, we keep only the codemeta option (but I haven't had the time to modify it myself)

39 ↗(On Diff #4770)


41 ↗(On Diff #4770)

erase (this does not mean we change the code, just the way we present what we want

137 ↗(On Diff #4770)

needs=> requires

- A multipart deposit (create or update) requires:
         -an existing software compressed archive
         -an existing metadata file or authors and name provided in params
141 ↗(On Diff #4770)


144 ↗(On Diff #4770)


145 ↗(On Diff #4770)

without ( )

metadata file or the authors and software artifact name provided in params
147 ↗(On Diff #4770)

and erase to be provided

A deposit update requires a deposit_id

LGTM but I did not do a very punctilious review


Looks great!
small language changes to clarify..

Awesome, thanks, i will adapt accordingly!

ardumont added inline comments.
77 ↗(On Diff #4770)

Positive sentence are clearer indeed!

ardumont marked an inline comment as done.

Docs: Improve sentence phrasing

Rework commits and messages

This revision was automatically updated to reflect the committed changes.