.. image:: https://travis-ci.com/fair-research/minid.svg?branch=develop :target: https://travis-ci.com/fair-research/minid
.. image:: https://coveralls.io/repos/github/fair-research/minid/badge.svg?branch=develop :target: https://coveralls.io/github/fair-research/minid?branch=develop
.. image:: https://img.shields.io/pypi/v/minid.svg :target: https://pypi.python.org/pypi/minid
.. image:: https://img.shields.io/pypi/wheel/minid.svg :target: https://pypi.python.org/pypi/minid
.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg :alt: License :target: https://opensource.org/licenses/Apache-2.0
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).
See the Read The Docs <https://minid.readthedocs.io/en/stable>
_ page for more info.
Minid 2.0.0 requires python 3.6 or higher::
$ pip install minid
Minting identifiers is simple and easy::
$ minid login
$ minid register --test [--title <title>] <file_name> [--locations <loc1>..<locN>]
Add a CLI 'config' command for changing some general runtime behaviors of the Minid Client. Currently, the Minid Client will collect some general info like "name" automatically from Globus Auth for use when registering new Minids. We probably want 'name' to be configurable based on the user's preference.
The previous Minid version saved the following information:
[general]
minid_server: http://minid.bd2k.org/minid
username: <Name>
email: <email>
orcid: <Orcid>
code: <code>
We may want to track minid_server
but I don't think anything else applies. username
and email
were used to track user info for the old Minid Service. code
was used to verify users. username
, email
, code
is functionally replaced by Globus Auth. orcid
currently isn't used, although we could add it if we wanted to supply it as additional metadata.
The MinidClient class should track configuration in a config
variable, so it is accessible by both the SDK and the CLI.
The ability to look up all the minids I've minted would ease medium-term maintenance and updates or redirects.
See details in the CHANGELOG
See details in the CHANGELOG
See the CHANGELOG for a list of features, changes, and fixes.
Beta 5 Release
See the CHANGELOG for a list of features, changes, and fixes.
Beta 4 Release
See the CHANGELOG for a list of features, changes, and fixes.
Beta 3 Release
See the CHANGELOG for a list of features, changes, and fixes.
Best practices, tools and tips for integrating FAIR data principals into your daily work
GitHub Repository