A CLI tool to deal with OKH data files. Its main functionalities are:
- validation of, and
- conversion between
different formats of OKH
- 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.
This repo contains two pieces of software:
okh-toolfetch-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
The okh-tool is written in rust, and can be compiled like this:
cargo build --releaseThis will produce the stand-alone binary tool in target/release/okh-tool.
To run it, you have these options for conversion:
$ okh-tool conv --help
okh-tool-conv 0.1.0
Converts one format into an other (currently only OKH-v1 to OKH-LOSH)
USAGE:
okh-tool conv [OPTIONS] <INPUT> [OUTPUT]
ARGS:
<INPUT> The input file or dir path
<OUTPUT> The output file or dir path
OPTIONS:
-c, --continue If the input path is a directory, continue processing further files, even
after an error
-h, --help Print help information
-o, --overwrite If the outout file alreayd exists, overwrite it, instead of skipping the
conversion
-r, --recursive If the input path is a directory, search for input files recursively
-V, --version Print version informationand these for validation:
$ okh-tool val --help
okh-tool-val 0.1.0
Validates manifest files for validity using JSON Schema (currently supports OKH-v1 and OKH-LOSH)
USAGE:
okh-tool val [OPTIONS] <INPUT>
ARGS:
<INPUT> The input file or dir path
OPTIONS:
-c, --continue If the input path is a directory, continue processing further
files, even after an error
-h, --help Print help information
-o, --okh-version <okh-version> If the input path is a directory, search for input files
recursively [possible values: v1, losh]
-r, --recursive If the input path is a directory, search for input files
recursively
-V, --version Print version informationOnce 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.
./fetch-n-conv-v1This 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.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent