diff --git a/docs/dev-info.rst b/docs/dev-info.rst index 9405120f..ecef1b49 100644 --- a/docs/dev-info.rst +++ b/docs/dev-info.rst @@ -1,178 +1,178 @@ .. _swh-deposit-dev: Hacking on swh-deposit ====================== There are multiple modes to run and test the server locally: * development-like (automatic reloading when code changes) * production-like (no reloading) * integration tests (no side effects) Except for the tests which are mostly side effects free (except for the database access), the other modes will need some configuration files (up to 2) to run properly. Database -------- swh-deposit uses a database to store the state of a deposit. The default db is expected to be called swh-deposit-dev. To simplify the use, the following makefile targets can be used: schema -~~~~~~ +^^^^^^ .. code:: shell make db-create db-prepare db-migrate data -~~~~ +^^^^ Once the db is created, you need some data to be injected (request types, client, collection, etc...): .. code:: shell make db-load-data db-load-private-data The private data are about having a user (``hal``) with a password (``hal``) who can access a collection (``hal``). Add the following to ``../private-data.yaml``: .. code:: yaml - model: deposit.depositclient fields: user_ptr_id: 1 collections: - 1 - model: auth.User pk: 1 fields: first_name: hal last_name: hal username: hal password: "pbkdf2_sha256$30000$8lxjoGc9PiBm$DO22vPUJCTM17zYogBgBg5zr/97lH4pw10Mqwh85yUM=" - model: deposit.depositclient fields: user_ptr_id: 1 collections: - 1 url: https://hal.inria.fr drop -~~~~ +^^^^ For information, you can drop the db: .. code:: shell make db-drop Development-like environment ---------------------------- Development-like environment needs one configuration file to work properly. Configuration -~~~~~~~~~~~~~ +^^^^^^^^^^^^^ **``{/etc/softwareheritage | ~/.config/swh | ~/.swh}``/deposit/server.yml**: .. code:: yaml # dev option for running the server locally host: 127.0.0.1 port: 5006 # production authentication: activated: true white-list: GET: - / # 20 Mib max size max_upload_size: 20971520 Run -~~~ +^^^ Run the local server, using the default configuration file: .. code:: shell make run-dev Production-like environment --------------------------- Production-like environment needs additional section in the configuration file to work properly. This is more close to what's actually running in production. Configuration -~~~~~~~~~~~~~ +^^^^^^^^^^^^^ This expects the same file describes in the previous chapter. Plus, an additional private section file containing private information that is not in the source code repository. **``{/etc/softwareheritage | ~/.config/swh | ~/.swh}``/deposit/private.yml**: .. code:: yaml private: secret_key: production-local db: name: swh-deposit-dev A production configuration file would look like: .. code:: yaml private: secret_key: production-secret-key db: name: swh-deposit-dev host: db port: 5467 user: user password: user-password Run -~~~ +^^^ .. code:: shell make run Note: This expects gunicorn3 package installed on the system Tests ----- To run the tests: .. code:: shell make test As explained, those tests are mostly side-effect free. The db part is dealt with by django. The remaining part which patches those side-effect behavior is dealt with in the ``swh/deposit/tests/__init__.py`` module. Sum up ------ Prepare everything for your user to run: .. code:: shell make db-drop db-create db-prepare db-migrate db-load-private-data run-dev diff --git a/docs/metadata.rst b/docs/metadata.rst index aac43369..f98a325d 100644 --- a/docs/metadata.rst +++ b/docs/metadata.rst @@ -1,200 +1,200 @@ .. _deposit-metadata: Deposit metadata ================ When making a software deposit into the SWH archive, one can add information describing the software artifact and the software project. .. _metadata-requirements: Metadata requirements --------------------- - **the schema/vocabulary** used *MUST* be specified with a persistent url (DublinCore, DOAP, CodeMeta, etc.) .. code:: xml or or - **the name** of the software deposit *MUST* be provided [atom:title, codemeta:name, dcterms:title] - **the authors** of the software deposit *MUST* be provided - **the url** representing the location of the source *MAY* be provided under the url tag. The url will be used for creating an origin object in the archive. .. code:: xml http://example.com/my_project - **the create\_origin** tag *SHOULD* be used to specify the URL of the origin to create (otherwise, a fallback is created using the slug, or a random string if missing) - **the description** of the software deposit *SHOULD* be provided [codemeta:description]: short or long description of the software - **the license/s** of the software deposit *SHOULD* be provided [codemeta:license] - other metadata *MAY* be added with terms defined by the schema in use. Examples -------- Using only Atom -~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^ .. code:: xml Awesome Compiler urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a 2017-10-07T15:17:08Z some awesome author Using Atom with CodeMeta -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: xml Awesome Compiler urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a 1785io25c695 origin url other identifier, DOI, ARK Domain description key-word 1 key-word 2 creation date publication date comment article name article id Collaboration/Projet project name id see also Sponsor A Sponsor B Platform/OS dependencies Version active license url spdx .Net Framework 3.0 Python2.3 author1 Inria UPMC author2 Inria UPMC http://code.com language 1 language 2 http://issuetracker.com Using Atom with DublinCore and CodeMeta (multi-schema entry) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: xml Awesome Compiler urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a hal-01587361 doi:10.5281/zenodo.438684 The assignment problem AffectationRO author [INFO] Computer Science [cs] [INFO.INFO-RO] Computer Science [cs]/Operations Research [cs.RO] SOFTWARE Project in OR: The assignment problemA java implementation for the assignment problem first release description fr 2015-06-01 2017-10-19 en origin url 1.0.0 key word Comment Rfrence interne link Sponsor Platform/OS dependencies Ended license url spdx http://code.com language 1 language 2 Note ---- We aim on harmonizing the metadata from different origins and thus metadata will be translated to the `CodeMeta v.2 `__ vocabulary if possible. diff --git a/docs/specs/blueprint.rst b/docs/specs/blueprint.rst index 93930b58..c94f0c07 100644 --- a/docs/specs/blueprint.rst +++ b/docs/specs/blueprint.rst @@ -1,194 +1,194 @@ Use cases ---------- +========= The general idea is that a deposit can be created either in a single request or by multiple requests to allow the user to add elements to the deposit piece by piece (be it the deposited data or the metadata describing it). An update request that does not have the `In-Progress: true` HTTP header will de facto declare the deposit as *completed* (aka in the `deposited` status; see below) and thus ready for ingestion. Once the deposit is declared *complete* by the user, the server performs a few validation checks. Then, if valid, schedule the ingestion of the deposited data in the Software Heritage Archive (SWH). There is a `status` property attached to a deposit allowing to follow the processing workflow of the deposit. For example, when this ingestion task completes successfully, the deposit is marked as `done`. Possible deposit statuses are: partial The deposit is partially received, since it can be done in multiple requests. expired Deposit was there too long and is new deemed ready to be garbage-collected. deposited Deposit is complete, ready to be checked. rejected Deposit failed the checks. verified Deposit passed the checks and is ready for loading. loading Injection is ongoing on SWH's side. done Loading is successful. failed Loading failed. This document describes the possible scenarios for creating or updating a deposit. Deposit creation -~~~~~~~~~~~~~~~~ +---------------- From client's deposit repository server to SWH's repository server: 1. The client requests for the server's abilities and its associated :ref:`collections ` using the *SD/service document uri* (:http:get:`/1/servicedocument/`). 2. The server answers the client with the service document which lists the *collections* linked to the user account (most of the time, there will one and only one collection linked to the user's account). Each of these collection can be used to push a deposit via its *COL/collection IRI*. 3. The client sends a deposit (a zip archive, some metadata or both) through the *COL/collection uri*. This can be done in: * one POST request (metadata + archive) without the `In-Progress: true` header: - :http:post:`/1/(str:collection-name)/` * one POST request (metadata or archive) **with** `In-Progress: true` header: - :http:post:`/1/(str:collection-name)/` plus one or more PUT or POST requests *to the update uris* (*edit-media iri* or *edit iri*): - :http:post:`/1/(str:collection-name)/(int:deposit-id)/media/` - :http:put:`/1/(str:collection-name)/(int:deposit-id)/media/` - :http:post:`/1/(str:collection-name)/(int:deposit-id)/metadata/` - :http:put:`/1/(str:collection-name)/(int:deposit-id)/metadata/` Then: a. Server validates the client's input or returns detailed error if any. b. Server stores information received (metadata or software archive source code or both). 4. The server notifies the client it acknowledged the client's request. An ``http 201 Created`` response with a deposit receipt in the body response is sent back. That deposit receipt will hold the necessary information to eventually complete the deposit later on if it was incomplete (also known as status ``partial``). Schema representation ^^^^^^^^^^^^^^^^^^^^^ Scenario: pushing a deposit via the SWORDv2_ protocol (nominal scenario): .. figure:: ../images/deposit-create-chart.svg :alt: Updating an existing deposit -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +"""""""""""""""""""""""""""" 5. Client updates existing deposit through the *update uris* (one or more POST or PUT requests to either the *edit-media iri* or *edit iri*). 1. Server validates the client's input or returns detailed error if any 2. Server stores information received (metadata or software archive source code or both) This would be the case for example if the client initially posted a ``partial`` deposit (e.g. only metadata with no archive, or an archive without metadata, or a split archive because the initial one exceeded the limit size imposed by swh repository deposit). The content of a deposit can only be updated while it is in the ``partial`` state; this causes the content to be **replaced** (the old version is discarded). Its metadata, however, can also be updated while in the ``done`` state; which adds a new version of the metadata in the SWH archive, **in addition to** the old one(s). In this state, ``In-Progress`` is not allowed, so the deposit cannot go back in the ``partial`` state, but only to ``deposited``. As a failsafe, to avoid accidentally updating the wrong deposit, this requires the ``X-Check-SWHID`` HTTP header to be set to the value of the SWHID of the deposit's content (returned after the deposit finished loading). Schema representation -^^^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""""" Scenario: updating a deposit via SWORDv2_ protocol: .. figure:: ../images/deposit-update-chart.svg :alt: Deleting deposit (or associated archive, or associated metadata) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 6. Deposit deletion is possible as long as the deposit is still in ``partial`` state. 1. Server validates the client's input or returns detailed error if any 2. Server actually delete information according to request Schema representation ^^^^^^^^^^^^^^^^^^^^^ Scenario: deleting a deposit via SWORDv2_ protocol: .. figure:: ../images/deposit-delete-chart.svg :alt: Client asks for operation status -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +"""""""""""""""""""""""""""""""" 7. Operation status can be read through a GET query to the *state iri*. Server: Triggering deposit checks -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +""""""""""""""""""""""""""""""""" Once the status ``deposited`` is reached for a deposit, checks for the associated archive(s) and metadata will be triggered. If those checks fail, the status is changed to ``rejected`` and nothing more happens there. Otherwise, the status is changed to ``verified``. Server: Triggering deposit load -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +""""""""""""""""""""""""""""""" Once the status ``verified`` is reached for a deposit, loading the deposit with its associated metadata will be triggered. The loading will result on status update, either ``done`` or ``failed`` (depending on the loading's status). This is described in the :ref:`loading specifications document `. .. _SWORDv2: http://swordapp.github.io/SWORDv2-Profile/SWORDProfile.html diff --git a/docs/specs/protocol-reference.rst b/docs/specs/protocol-reference.rst index fa7cbce2..daefac5b 100644 --- a/docs/specs/protocol-reference.rst +++ b/docs/specs/protocol-reference.rst @@ -1,277 +1,277 @@ .. _deposit-protocol: Protocol reference -~~~~~~~~~~~~~~~~~~ +================== The swh-deposit protocol is an extension SWORDv2_ protocol, and the swh-deposit client and server should work with any other SWORDv2-compliant implementation which provides some :ref:`mandatory attributes ` However, we define some extensions by the means of extra tags in the Atom entries, that should be used when interacting with the server to use it optimally. This means the swh-deposit server should work with a generic SWORDv2 client, but works much better with these extensions. All these tags are in the ``https://www.softwareheritage.org/schema/2018/deposit`` XML namespace, denoted using the ``swhdeposit`` prefix in this section. Origin creation with the ```` tag -=========================================================== +----------------------------------------------------------- Motivation ----------- +^^^^^^^^^^ This is the main extension we define. This tag is used after a deposit is completed, to load it in the Software Heritage archive. The SWH archive references source code repositories by an URI, called the :term:`origin` URL. This URI is clearly defined when SWH pulls source code from such a repository; but not for the push approach used by SWORD, as SWORD clients do not intrinsically have an URL. Usage ------ +^^^^^ Instead, clients are expected to provide the origin URL themselves, by adding a tag in the Atom entry they submit to the server, like this: .. code:: xml This will create an origin in the Software Heritage archive, that will point to the source code artifacts of this deposit. Semantics of origin URLs ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Origin URLs must be unique to an origin, ie. to a software project. The exact definition of a "software project" is left to the clients of the deposit. They should be designed so that future releases of the same software will have the same origin URL. As a guideline, consider that every GitHub/GitLab project is an origin, and every package in Debian/NPM/PyPI is also an origin. While origin URLs are not required to resolve to a source code artifact, we recommend they point to a public resource describing the software project, including a link to download its source code. This is not a technical requirement, but it improves discoverability. Clients may not submit arbitrary URLs; the server will check the URLs they submit belongs a "namespace" they own, known as the ``provider_url`` of the client. For example, if a client has their ``provider_url`` set to ``https://example.org/foo/`` they will not be able to submit deposits to origins whose URL starts with ``https://example.org/foo/``. Fallbacks ---------- +^^^^^^^^^ If the ```` is not provided (either because they are generic SWORDv2 implementations or old implementations of an swh-deposit client), the server falls back to creating one based on the ``provider_url`` and the ``Slug`` header (as defined in the AtomPub_ specification) by concatenating them. If the ``Slug`` header is missing, the server generates one randomly. This fallback is provided for compliance with SWORDv2_ clients, but we do not recommend relying on it, as it usually creates origins URL that are not meaningful. Adding releases to an origin, with the ```` tag -========================================================================= +------------------------------------------------------------------------- When depositing a source code artifact for an origin (ie. software project) that was already deposited before, clients should not use ````, as the origin was already created by the original deposit; and ```` should be used instead. It is used very similarly to ````: .. code:: xml This will create a new :term:`revision` object in the Software Heritage archive, with the last deposit on this origin as its parent revision, and reference it from the origin. If the origin does not exist, it will error. Metadata -======== +-------- Format ------- +^^^^^^ While the SWORDv2 specification recommends the use of DublinCore_, we prefer the CodeMeta_ vocabulary, as we already use it in other components of Software Heritage. While CodeMeta is designed for use in JSON-LD, it is easy to reuse its vocabulary and embed it in an XML document, in three steps: 1. use the JSON-LD compact representation of the CodeMeta document 2. replace ``@context`` declarations with XML namespaces 3. unfold JSON lists to sibling XML subtrees For example, this CodeMeta document: .. code:: json { "@context": "https://doi.org/10.5063/SCHEMA/CODEMETA-2.0", "name": "My Software", "author": [ { "name": "Author 1", "email": "foo@example.org" }, { "name": Author 2" } ] } becomes this XML document: .. code:: xml My Software Author 1 foo@example.org Author 2 Or, equivalently: .. code:: xml My Software Author 1 foo@example.org Author 2 .. _mandatory-attributes: Mandatory attributes --------------------- +^^^^^^^^^^^^^^^^^^^^ All deposits must include: * an ```` tag with an ```` and ````, and * either ```` or ```` We also highly recommend their CodeMeta equivalent, and any other relevant metadata, but this is not enforced. .. _metatadata-only-deposit Metadata-only deposit -===================== +--------------------- The swh-deposit server can also be without a source code artifact, but only to provide metadata that describes an arbitrary origin or object in Software Heritage; known as extrinsic metadata. Unlike regular deposits, there are no restricting on URL prefixes, so any client can provide metadata on any origin; and no restrictions on which objects can be described. This is done by simply omitting the binary file deposit request of a regular SWORDv2 deposit, and including information on which object the metadata describes, by adding a ```` tag in the Atom document. To describe an origin: .. code:: xml And to describe an object: .. code:: xml For details on the semantics, see the :ref:`metadata deposit specification ` .. _SWORDv2: http://swordapp.github.io/SWORDv2-Profile/SWORDProfile.html .. _AtomPub: https://tools.ietf.org/html/rfc5023 .. _DublinCore: https://www.dublincore.org/ .. _CodeMeta: https://codemeta.github.io/ diff --git a/docs/specs/spec-meta-deposit.rst b/docs/specs/spec-meta-deposit.rst index ff7b17e3..43c900af 100644 --- a/docs/specs/spec-meta-deposit.rst +++ b/docs/specs/spec-meta-deposit.rst @@ -1,135 +1,135 @@ .. _spec-metadata-deposit: The metadata-only deposit -^^^^^^^^^^^^^^^^^^^^^^^^^ +========================= Goal -==== +---- A client may wish to deposit only metadata about an origin or object already present in the Software Heritage archive. The metadata-only deposit is a special deposit where no content is provided and the data transferred to Software Heritage is only the metadata about an object in the archive. Requirements -============ +------------ 1. Create a metadata-only deposit through a :ref:`POST request` 2. It is composed of ONLY one Atom XML document 3. It MUST comply with :ref:`the metadata requirements` 4. It MUST reference an **object** or an **origin** in a deposit tag 5. The reference SHOULD exist in the SWH archive 6. The **object** reference MUST be a SWHID on one of the following artifact types: - origin - snapshot - release - revision - directory - content 7. The SWHID MAY be a `core identifier`_ with or without `qualifiers`_ 8. The SWHID MUST NOT reference a fragment of code with the classifier `lines` .. _core identifier: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#core-identifiers .. _qualifiers: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#qualifiers A complete metadata example -=========================== +--------------------------- The reference element is included in the metadata xml atomEntry under the swh namespace: .. code:: xml HAL hal@ccsd.cnrs.fr The assignment problem https://hal.archives-ouvertes.fr/hal-01243573 other identifier, DOI, ARK Domain description Author1 Inria UPMC Author2 Inria UPMC References -========== +---------- The metadata reference can be either on: - an origin - a graph object (core SWHID with or without qualifiers) Origins -------- +^^^^^^^ The metadata may be on an origin, identified by the origin's URL: .. code:: xml Graph objects -------------- +^^^^^^^^^^^^^ It may also reference an object in the `SWH graph `: contents, directories, revisions, releases, and snapshots: .. code:: xml .. code:: xml The value of the ``swhid`` attribute must be a `SWHID `, with any context qualifiers in this list: * ``origin`` * ``visit`` * ``anchor`` * ``path`` and they should be provided whenever relevant, especially ``origin``. Other qualifiers are not allowed (for example, ``line`` isn't because SWH cannot store metadata at a finer level than entire contents). Loading procedure -================= +----------------- In this case, the metadata-deposit will be injected as a metadata entry of the relevant object, with the information about the contributor of the deposit. diff --git a/docs/user-manual.rst b/docs/user-manual.rst index 56ee707e..9b385679 100644 --- a/docs/user-manual.rst +++ b/docs/user-manual.rst @@ -1,486 +1,486 @@ .. _user-manual: User Manual =========== This is a guide for how to prepare and push a software deposit with the `swh deposit` commands. Requirements ------------ You need to have an account on the Software Heritage deposit application to be able to use the service. Please `contact the Software Heritage team `_ for more information on how to get access to this service. For testing purpose, a test instance `is available `_ [#f1]_ and will be used in the examples below. Once you have an account, you should get a set of access credentials as a `login` and a `password` (identified as ```` and ```` in the remaining of this document). A deposit account also comes with a "provider URL" which is used by SWH to build the :term:`Origin URL` of deposits created using this account. Installation ------------ To install the `swh.deposit` command line tools, you need a working Python 3.7+ environment. It is strongly recommended you use a `virtualenv `_ for this. .. code:: console $ python3 -m virtualenv deposit [...] $ source deposit/bin/activate (deposit)$ pip install swh.deposit [...] (deposit)$ swh deposit --help Usage: swh deposit [OPTIONS] COMMAND [ARGS]... Deposit main command Options: -h, --help Show this message and exit. Commands: admin Server administration tasks (manipulate user or... status Deposit's status upload Software Heritage Public Deposit Client Create/Update... (deposit)$ Note: in the examples below, we use the `jq`_ tool to make json outputs nicer. If you do have it already, you may install it using your distribution's packaging system. For example, on a Debian system: .. _jq: https://stedolan.github.io/jq/ .. code:: console $ sudo apt install jq .. _prepare_deposit 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`) * (Optional) prepare a metadata file (more details :ref:`deposit-metadata`): Example: Assuming you want to deposit the source code of `belenios `_ version 1.12 .. code:: console (deposit)$ wget https://gitlab.inria.fr/belenios/belenios/-/archive/1.12/belenios-1.12.zip [...] 2020-10-28 11:40:37 (4,56 MB/s) - ‘belenios-1.12.zip’ saved [449880/449880] (deposit)$ Then you need to prepare a metadata file allowing you to give detailed information on your deposited source code. A rather minimal Atom with Codemeta file could be: .. code:: console (deposit)$ cat metadata.xml Verifiable online voting system belenios-01243065 https://gitlab.inria.fr/belenios/belenios test Online voting Verifiable online voting system 1.12 opam stable ocaml GNU Affero General Public License Belenios belenios@example.com Belenios Test User (deposit)$ Please read the :ref:`deposit-metadata` page for a more detailed view on the metadata file formats and semantics. Push a deposit -------------- You can push a deposit with: * a 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 multisteps 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``) * a metadata-only deposit: The user posts in one query an associated metadata file on a :ref:`SWHID ` object. The deposit is directly marked with status ``done``. Overall, a deposit can be a in series of steps as follow: .. figure:: images/status.svg :alt: The important things to notice for now is that it can be: partial: the deposit is partially received expired: deposit has been there too long and is now deemed ready to be garbage collected deposited: deposit is complete and is ready to be checked to ensure data consistency verified: deposit is fully received, checked, and ready for loading loading: loading is ongoing on swh's side done: loading is successful failed: loading is a failure When you push a deposit, it is either in the `deposited` state or in the `partial` state if you asked for a partial upload. Single deposit ^^^^^^^^^^^^^^ Once the files are ready for deposit, we want to do the actual deposit in one shot, i.e. sending both the archive (zip) file and the metadata file. * 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 * archive's path (example: ``--archive path/to/archive-name.tgz``) * metadata file path (example: ``--metadata path/to/metadata.xml``) to the `swh deposit upload` command. Example: To push the Belenios 1.12 we prepared previously on the testing instance of the deposit: .. code:: console (deposit)$ ls belenios-1.12.zip metadata.xml deposit (deposit)$ swh deposit upload --username --password \ --url https://deposit.staging.swh.network/1 \ --slug belenios-01243065 \ --archive belenios.zip \ --metadata metadata.xml \ --format json | jq { 'deposit_status': 'deposited', 'deposit_id': '1', 'deposit_date': 'Oct. 28, 2020, 1:52 p.m.', 'deposit_status_detail': None } (deposit)$ You just posted a deposit to your main collection on Software Heritage (staging area)! The returned value is a JSON dict, in which you will notably find the deposit id (needed to check for its status later on) and the current status, which should be `deposited` if no error has occurred. Note: As the deposit is in ``deposited`` status, you can no longer update the deposit after this query. It will be answered with a 403 (Forbidden) answer. If something went wrong, an equivalent response will be given with the `error` and `detail` keys explaining the issue, e.g.: .. code:: console { 'error': 'Unknown collection name xyz', 'detail': None, 'deposit_status': None, 'deposit_status_detail': None, 'deposit_swh_id': None, 'status': 404 } Once the deposit has been done, you can check its status using the `swh deposit status` command: .. code:: console (deposit)$ swh deposit status --username --password \ --url https://deposit.staging.swh.network/1 \ --deposit-id 1 -f json | jq { "deposit_id": "1", "deposit_status": "done", "deposit_status_detail": "The deposit has been successfully loaded into the Software Heritage archive", "deposit_swh_id": "swh:1:dir:63a6fc0ed8f69bf66ccbf99fc0472e30ef0a895a", "deposit_swh_id_context": "swh:1:dir:63a6fc0ed8f69bf66ccbf99fc0472e30ef0a895a;origin=https://softwareheritage.org/belenios-01234065;visit=swh:1:snp:0ae536667689da7047bfb7aa9f37f5958e9f4647;anchor=swh:1:rev:17ad98c940104d45b6b6bd6fba9aa832eeb95638;path=/", "deposit_external_id": "belenios-01234065" } Metadata-only deposit ^^^^^^^^^^^^^^^^^^^^^ This allows to deposit only metadata information on a :ref:`SWHID reference `. Prepare a metadata file as described in the :ref:`prepare deposit section ` Ensure this metadata file also declares a :ref:`SWHID reference `: .. code:: xml For this, we then need to provide the following information: * arguments: ``--username 'name' --password 'pass'`` as credentials * metadata file path (example: ``--metadata path/to/metadata.xml``) to the `swh deposit metadata-only` command. Example: .. code:: console (deposit) swh deposit metadata-only --username --password \ --url https://deposit.staging.swh.network/1 \ --metadata ../deposit-swh.metadata-only.xml \ --format json | jq . { "deposit_id": "29", "deposit_status": "done", "deposit_date": "Dec. 15, 2020, 11:37 a.m." } For details on the metadata-only deposit, see the :ref:`metadata-only deposit protocol reference ` Multisteps deposit ^^^^^^^^^^^^^^^^^^ In this case, the deposit is created by several requests, uploading objects piece by piece. The steps to create a multisteps deposit: 1. Create an partial deposit -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +"""""""""""""""""""""""""""" First use the ``--partial`` argument to declare there is more to come .. code:: console $ swh deposit upload --username name --password secret \ --archive foo.tar.gz \ --partial 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. To only add one new archive to the deposit: .. code:: console $ swh deposit upload --username name --password secret \ --archive add-foo.tar.gz \ --deposit-id 42 \ --partial To only add metadata to the deposit: .. code:: console $ swh deposit upload --username name --password secret \ --metadata add-foo.tar.gz.metadata.xml \ --deposit-id 42 \ --partial 3. Finalize deposit -~~~~~~~~~~~~~~~~~~~ +""""""""""""""""""" On your last addition (same command as before), by not declaring it ``--partial``, the deposit will be considered completed. Its status will be changed to ``deposited``: .. code:: console $ swh deposit upload --username name --password secret \ --metadata add-foo.tar.gz.metadata.xml \ --deposit-id 42 Update deposit -------------- * Update deposit metadata: - only possible if the deposit status is ``done``, ``--deposit-id `` and ``--swhid `` are provided - by using the ``--metadata`` flag, a path to an xml file .. code:: console $ swh deposit upload \ --username name --password secret \ --deposit-id 11 \ --swhid swh:1:dir:2ddb1f0122c57c8479c28ba2fc973d18508e6420 \ --metadata ../deposit-swh.update-metadata.xml * Replace deposit: - only possible if the deposit status is ``partial`` and ``--deposit-id `` is provided - by using the ``--replace`` flag - ``--metadata-deposit`` replaces associated existing metadata - ``--archive-deposit`` replaces associated archive(s) - by default, with no flag or both, you'll replace associated metadata and archive(s): .. code:: console $ swh deposit upload --username name --password secret \ --deposit-id 11 \ --archive updated-je-suis-gpl.tgz \ --replace * Update a loaded deposit with a new version (this creates a new deposit): - by using the external-id with the ``--slug`` argument, you will link the new deposit with its parent deposit: .. code:: console $ swh deposit upload --username name --password secret \ --archive je-suis-gpl-v2.tgz \ --slug 'je-suis-gpl' Check the deposit's status -------------------------- You can check the status of the deposit by using the ``--deposit-id`` argument: .. code:: console $ swh deposit status --username name --password secret \ --deposit-id 11 .. code:: json { "deposit_id": 11, "deposit_status": "deposited", "deposit_swh_id": null, "deposit_status_detail": "Deposit is ready for additional checks \ (tarball ok, metadata, etc...)" } 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:: json { "deposit_id": 11, "deposit_status": "done", "deposit_swh_id": "swh:1:dir:d83b7dda887dc790f7207608474650d4344b8df9", "deposit_swh_id_context": "swh:1:dir:d83b7dda887dc790f7207608474650d4344b8df9;\ origin=https://forge.softwareheritage.org/source/jesuisgpl/;\ visit=swh:1:snp:68c0d26104d47e278dd6be07ed61fafb561d0d20;\ anchor=swh:1:rev:e76ea49c9ffbb7f73611087ba6e999b19e5d71eb;path=/", "deposit_status_detail": "The deposit has been successfully \ loaded into the Software Heritage archive" } .. rubric:: Footnotes .. [#f1] the test instance of the deposit is not yet available to external users, but it should be available soon.