Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoijui/osh-dir-std-rs
Code that helps humans and machines deal with the OSH directory standard
https://github.com/hoijui/osh-dir-std-rs
cli interfacer-project-eu interfacer-project-eu-wp4-3 library open-source-hardware oseg standard
Last synced: about 1 month ago
JSON representation
Code that helps humans and machines deal with the OSH directory standard
- Host: GitHub
- URL: https://github.com/hoijui/osh-dir-std-rs
- Owner: hoijui
- License: agpl-3.0
- Created: 2022-11-25T17:10:01.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-03T11:42:44.000Z (6 months ago)
- Last Synced: 2024-10-06T17:35:34.567Z (about 1 month ago)
- Topics: cli, interfacer-project-eu, interfacer-project-eu-wp4-3, library, open-source-hardware, oseg, standard
- Language: Rust
- Homepage:
- Size: 161 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OSH directory standard - Rust library
[](
LICENSE.txt)
[](
https://api.reuse.software/info/github.com/hoijui/osh-dir-std-rs)
[](
https://github.com/hoijui/osh-dir-std-rs)
[](
https://crates.io/crates/osh_dir_std)
[](
https://docs.rs/osh_dir_std)
[](
https://deps.rs/repo/github/hoijui/osh-dir-std-rs)
[](
https://github.com/hoijui/osh-dir-std-rs/actions)
[](
https://fabcity.hamburg)
[](
https://opensourceecology.de)
* OSH: _**O**pen **S**ource **H**ardware_
Code that helps humans and machines deal with
the [OSH directory standard](
https://github.com/hoijui/osh-dir-std).
This consists of two parts:
1. `osh_dir_std` - a (Rust) library to parse the specification(s)
into easily usable structures & accompanying utilities
2. `osh-dir-std` - a CLI tool that helps checking a given projects file listing
against one or multiple specifications.
**NOTE** \
This only checks the paths of files and directories
against a set of presets (aka "standards").
It does _not_ check the content of any files in any way.
## Example Usage
### CLI
#### Installation
##### From Source
###### Fetch & Compile
```shell
cargo install osh-dir-std
```
###### Local Sources
```shell
cargo install --path bin
```
#### Usage
The tool expects a new-line separated listing of files
(and optionally directories) of the project,
either on [`stdin`](
https://en.wikipedia.org/wiki/Standard_streams#Standard_input_(stdin)),
or in a file given as the first argument.
This list might come from git
(or any other [version control system (VCS)](
https://en.wikipedia.org/wiki/Version_control) used),
the file-system directly,
a ZIP file or even a web-site that lists the files.
A few examples of how to list files in different scenarios,
to rate the project against the known directory standards:
[git](https://git-scm.com/):
```shell
git ls-files --recurse-submodules | sed -e 's/^"\(.*\)"$/\1/' | osh-dir-std rate
```
[SVN](https://subversion.apache.org/):
```shell
svn ls | osh-dir-std rate
```
[Mercurial (`hg`)](https://www.mercurial-scm.org/):
```shell
hg status --all | osh-dir-std rate
```
[pijul](https://pijul.org/):
```shell
pijul list | osh-dir-std rate
```
file-system:
```shell
ls -r1 | osh-dir-std rate
```
sample output:
```json
[
{
"name": "unixish",
"factor": 0.62724684
},
]
```
A factor of `1.0` would mean that the projects file- and directory structure
adheres 100% to the respective standard.
`unixish` is the name of the default directory standard.
### Library
#### Setup
_Cargo.toml_:
```toml
[dependencies]
osh_dir_std = "0.7.2"
```
#### Code
```rust
use osh_dir_std::{self, format::Rec};
fn find_rec(std: &str, record_path: &str) -> Result<&'static Rec<'static>, String> {
for rec in &osh_dir_std::data::STDS.get(std).unwrap().records {
if rec.path == record_path {
return Ok(rec);
}
}
Err(format!(
"Failed to find record with path '{record_path}' in the '{std}' dir standard"
))
}
/// Checks whether the dir std "unixish" contains the record "res/",
/// and whether that record is a _fixed_ one. See [the definition](
/// https://github.com/hoijui/osh-dir-std/blob/main/definition_format.csv)
/// for an explanation of what _fixed_ means.
#[test]
fn unixish_res_fixed() -> Result<(), Error> {
let rec = find_rec("unixish", "res/")?;
assert!(rec.fixed);
Ok(())
}
```
## Related Projects
* [`osh`-tool](https://github.com/hoijui/osh-tool) -
Checks an OSH project against a set of predefined checks,
to try to assess its overall machine-readability and openness. \
(also uses this tool internally)
## Funding
This project was funded by the European Regional Development Fund (ERDF)
in the context of the [INTERFACER Project](https://www.interfacerproject.eu/),
from November 2022 (project start)
until March 2023.
