Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
LOSH OKH tool
A CLI tool to deal with OKH data files. Its main functionalities are:
- validation of, and
- conversion between
different formats of OKH
Definitions
- LOSH: A Library of Open Source Hardware - technical documentation in an open graph database.
- OKH: Open Know-How - A standard for OSH project meta-data.
Intro
This repo contains two pieces of software:
okh-tool
fetch-n-conv-v1
and it uses the OKH JSON-Schemas repo as submodule.
The okh-tool
can:
- convert manifest files from one version of the OKH standard to an other
- validate manifest files of the different OKH standard versions. It does so by using the above mentioned JSON Schema files.
The fetch-n-conv-v1
script will:
- fetch publicly registered OKH v1 manifest files
- clean them up
- validate them
- convert them to OKH LOSH (aka "v2")
- validate the generated OKH LOSH manifest files
Usage
Conversion and Validation
The okh-tool
is written in rust, and can be compiled like this:
This will produce the stand-alone binary tool in target/release/okh-tool
.
To run it, you have these options for conversion:
<INPUT> The
<OUTPUT> The
)
and these for validation:
<INPUT> The
)
Fetching and converting OKH v1
Once you have the above described okh-tool
ready
(it is required by this script),
you may just start the whole process like follows;
but be wary, this may take around 3h
(99+% of which is spent downloading).
The already downloaded files will not be re-downloaded
when you abort the process and start a-new.
Funding
This project was funded by:
-
the European Union's Horizon 2020 research and innovation program, under grant agreement no. 869984, in the context of the OPEN!NEXT Project, from November 2021 (project start) until July 2022.
-
the European Regional Development Fund (ERDF) in the context of the INTERFACER Project, from August 2022 until March 2023.