diff --git a/docs/getting-started.rst b/docs/getting-started.rst index e09c5275..25714473 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -1,308 +1,323 @@ Getting Started =============== This is a guide for how to prepare and push a software deposit with the swh-deposit commands. The api is rooted at https://deposit.softwareheritage.org. For more details, see the `main documentation <./index.html>`__. Requirements ------------ You need to be referenced on SWH's client list to have: * a credential (needed for the basic authentication step) - - in this document we reference ```` as the client's name and ```` - as its associated authentication password. -* an associated collection (by default the client's name is the collection -name) + - in this document we reference ```` as the client's name and + ```` as its associated authentication password. + + * an associated collection `Contact us for more information. `__ Prepare a deposit ----------------- * compress the files in a supported archive format: - zip: common zip archive (no multi-disk zip files). - tar: tar archive without compression or optionally any of the following compression algorithm gzip (.tar.gz, .tgz), bzip2 (.tar.bz2) , or lzma (.tar.lzma) -* prepare a metadata file (more details `here <./metadata.html>`__.): +* prepare a metadata file (`more details <./metadata.html>`__.): - - specify metadata schema/vocabulry (CodeMeta is recommended) + - specify metadata schema/vocabulary (CodeMeta is recommended) - specify *MUST* metadata (url, authors, software name and the external\_identifier) - - add all available information under the compatible metadadata term + - add all available information under the compatible metadata term An example of an atom entry file with CodeMeta terms: .. code:: xml Je suis GPL 12345 forge.softwareheritage.org/source/jesuisgpl/ Yes, this is another implementation of "Hello, world!” when you run it. GPL https://www.gnu.org/licenses/gpl.html Reuben Thomas Maintainer Sami Kerola Maintainer Check authentication with a service document request ---------------------------------------------------- Start with a simple request to check credentials and retrieve the *collection iri* onto which the deposit will be pushed . .. code:: shell curl -i --user : https://deposit.softwareheritage.org/1/servicedocument/ The successful response: ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: shell HTTP/1.0 200 OK Server: WSGIServer/0.2 CPython/3.5.3 Content-Type: application/xml 2.0 209715200 The Software Heritage (SWH) Archive Software Collection application/zip application/x-tar Collection Policy Software Heritage Archive Collect, Preserve, Share false http://purl.org/net/sword/package/SimpleZip https://deposit.softwareheritage.org/1// The error response 401 for Unauthorized access: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: shell curl -i https://deposit.softwareheritage.org/1// - HTTP/1.0 401 Unauthorized - Server: WSGIServer/0.2 CPython/3.5.3 + HTTP/1.1 401 Unauthorized Content-Type: application/xml - WWW-Authenticate: Basic realm="" - X-Frame-Options: SAMEORIGIN - Access to this api needs authentication + Invalid username/password. processing failed + + API is protected by basic authentication + + Push deposit ------------ You can push a deposit with: * a one single deposit (archive + metadata): The user posts in one query a software source code archive and associated metadata. The deposit is directly marked with status ``deposited``. -* a multi-part deposit: +* a multipart deposit: 1. Create an incomplete deposit (marked with status ``partial``) 2. Add data to a deposit (in multiple requests if needed) 3. Finalize deposit (the status becomes ``deposited``) Single deposit ^^^^^^^^^^^^^^ Once the files are ready for deposit, we want to do the actual deposit in one shot, sending exactly one POST query: * 1 archive (content-type ``application/zip`` or ``application/x-tar``) * 1 metadata file in atom xml format (``content-type: application/atom+xml;type=entry``) For this, we need to provide: * the arguments: ``--username 'name' --password 'pass'`` as credentials * the name of the archive (example: ``path/to/archive-name.tgz``) * in the same location of the archive and with the following namimg pattern for the metadata file: ``path/to/archive-name.metadata.xml`` * optionally, the --slug 'your-id' argument, a reference to a unique identifier the client uses for the software object. You can do this with the following command: minimal deposit .. code:: shell $ swh-deposit --username 'name' --password 'pass' je-suis-gpl.tgz with the client's identifier .. code:: shell $ swh-deposit --username 'name' --password 'pass' je-suis-gpl.tgz --sulg '123456' deposit to a specific client's collection .. code:: shell $ swh-deposit --username 'name' --password 'pass' je-suis-gpl.tgz --collection 'second-collection' You just posted a deposit to your collection on Software Heritage If everything went well, a the successful response will contain the elements below: * ``HTTP/1.0 201 Created``: the deposit was created successfully -* Inforamtion about the deposit, such as: +* Information about the deposit, such as: * deposit id * deposit date * deposit status will be ``deposited`` * Entry points: * ``Location: /1///metadata/``: the EDIT-SE-IRI through which we can update a deposit's metadata * ``Location: /1///media/``: the EM-IRI through which we can update a deposit's content Note: As the deposit is in ``deposited`` status, you cannot update the deposit after this query. It will be answered with a 403 forbidden answer. -Multi-part deposit +multipart deposit ^^^^^^^^^^^^^^^^^^^^^^^^^ -The steps to create a multi-part deposit: +The steps to create a multipart deposit: 1. Create an incomplete deposit ~~~~~~~~~~~~~~~~~~~ First use the ``--partial`` argument to declare there is more to come .. code:: shell $ swh-deposit --username 'name' --password 'secret' --partial \ - foo.tar.gz + --archive foo.tar.gz 2. Add content or metadata to the deposit ~~~~~~~~~~~~~~~~~~~ Continue the deposit by using the ``--deposit-id`` argument given as a response for the first step. You can continue adding content or metadata while you use the ``--partial`` argument. .. code:: shell $ swh-deposit --username 'name' --password 'secret' --partial \ - --deposit-id 42 add-foo.tar.gz + --deposit-id 42 --archive add-foo.tar.gz 3. Finalize deposit ~~~~~~~~~~~~~~~~~~~ On your last addition, by not declaring it as ``--partial``, the deposit will be considered as completed and its status will be changed to ``deposited``. .. code:: shell $ swh-deposit --username 'name' --password 'secret' \ - --deposit-id 42 last-foo.tar.gz + --deposit-id 42 \ + --archive last-foo.tar.gz Update deposit ---------------- * replace deposit : - only possible if the deposit status is ``partial`` - by using the ``--replace`` argument .. code:: shell $ swh-deposit --username 'name' --password 'secret' --replace\ - --deposit-id 11 updated-je-suis-gpl.tar.gz + --deposit-id 11 \ + --archive updated-je-suis-gpl.tar.gz * update a loaded deposit with a new version: - by using the external-id with the ``--slug`` argument which will link the new deposit with its parent deposit .. code:: shell - $ swh-deposit --username 'name' --password 'pass' je-suis-gpl-v2.tgz --sulg '123456' + $ swh-deposit --username 'name' --password 'pass' --slug '123456' \ + --archive je-suis-gpl-v2.tgz Check the deposit's status -------------------------- You can check the status of the deposit by using the ``--deposit-id`` argument: .. code:: shell $ swh-deposit --login 'name' --pass 'secret' --deposit-id '11' --status Response: .. code:: xml 9 deposited deposit is fully received and ready for loading The different statuses: - *partial* : multipart deposit is still ongoing - *deposited*: deposit completed - *rejected*: deposit failed the checks - *verified*: content and metadata verified - *loading*: loading in-progress - *done*: loading completed successfully - *failed*: the deposit loading has failed -When the the deposit has been loaded into the archive it will be marked ``done`` -and in the response will be also available the . -For more information about the swh-id go to ..... +When the deposit has been loaded into the archive, the status will be +marked ``done``. In the response, will also be available the +. For example: + +.. code:: xml + + + 55 + done + The deposit has been successfully loaded into the Software Heritage archive + swh:1:rev:34898aa991c90b447c27d2ac1fc09f5c8f12783e +