Skip to main content

BD2K Minimum Viable Identifier

Project description

Minimal Viable Identifier Client
================================

A minid (Minimal Viable Identifier) is an identifier that is sufficiently simple to make creation and use trivial, while still having enough substance to make data easily findable, accessible, interoperable, and reusable (FAIR).

The minid server code is avaialble at `https://github.com/ini-bdds/minid-server <https://github.com/ini-bdds/minid-server>`_

Installation
------------

The minid client and CLI is avaialble on PyPI. You can install it with the following command::

$ pip install minid

ALternatively, you can download the source code and install using setup tools::

$ git clone git@github.com:ini-bdds/minid.git

$ python setup.py install

Configuration
-------------

Before using the API you first need to validate your email address. Enter the following command::

$ minid --register_user --email <email> --name <name> [--orcid <orcid>]

A unique code will be sent to your email address. You must present this code along with your
email address when accessing the API. As a convenience you can specify this information in
a minid configuration file (`~/.minid/minid-config.cfg`)


.. code-block:: none

[general]
minid_server: http://minid.bd2k.org/minid
user: <Name>
email: <Email>
orcid: <optional Orcid>
code: <Code>


Usage
----

The CLI supports the following simple operations (Note: the `--test` flag creates names in a test namespace that is removed periodically; remove that flag to create production minids.):

* Create a new identifier (the `--location` option, if provided, must be at the end)::

$ minid --test --register [--title <title>] <file_name> [--locations <loc1>..<locN>]

* Retrieve metadata about a file::

$ minid --test <file_name>

* Retrieve metadata about an identifier::

$ minid --test <identifier>

* Update metadata about an identifier::

$ minid --test --update [--title <title>] [--status <status>] [--obsoleted_by <minid>] [--locations <loc1> <loc2>] <identifier>

* View all minid options::

$ minid -h

Landing pages are accessible via the minid website: minid.bd2k.org/minid/landingpage/<identifier>.


file manifest format
--------------------
Minids can only be assigned to a single file. In order to assign a minid to a collection of files we recommend using a `BDBag <https://github.com/ini-bdds/bdbag>`_ or the minid file manifest format.

The minid file manifest format is a JSON-based format that enumerates a list of files as JSON objects that have the following attributes:

* length: The length of the file in bytes.

* filename: The filename (or path) relative to the manifest file.

* One or more (only one of each) of the following `algorithm:checksum` key-value pairs:

* md5:<md5 hex value>

* sha256:<sha256 hex value>

* sha512:<sha512 hex value>

Below is a sample file manifest configuration file::

[
{
"length":321,
"filename":"file1.json",
"md5":"9faccdb6f9a47a10d9a00bd2b13f7ab3",
"sha256":"eb42cbc9682e953a03fe83c5297093d95eec045e814517a4e891437b9b993139"
},
{
"length": 632860,
"filename": "minid_v0.1_Nov_2015.pdf",
"sha256": "cacc1abf711425d3c554277a5989df269cefaa906d27f1aaa72205d30224ed5f"
}
]


More information
----------------

More information about the project can be found at: `http://minid.bd2k.org/ <http://minid.bd2k.org/>`_

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for minid, version 1.2.2
Filename, size File type Python version Upload date Hashes
Filename, size minid-1.2.2.tar.gz (13.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page