Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoijui/osh-tool
A command line tool for Open Source Hardware (OSH) technical project linting (quality assessment).
https://github.com/hoijui/osh-tool
cli fchh hardware interfacer-project-eu interfacer-project-eu-wp4-3 open-source-hardware oseg tool
Last synced: about 16 hours ago
JSON representation
A command line tool for Open Source Hardware (OSH) technical project linting (quality assessment).
- Host: GitHub
- URL: https://github.com/hoijui/osh-tool
- Owner: hoijui
- License: agpl-3.0
- Created: 2022-09-20T14:11:20.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-11T14:51:22.000Z (10 months ago)
- Last Synced: 2024-11-07T23:48:16.598Z (12 days ago)
- Topics: cli, fchh, hardware, interfacer-project-eu, interfacer-project-eu-wp4-3, open-source-hardware, oseg, tool
- Language: Nim
- Homepage: https://hoijui.github.io/osh-tool/
- Size: 90.2 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# `osh`-tool
[](
https://www.gnu.org/licenses/agpl-3.0)
[](
https://api.reuse.software/info/github.com/hoijui/osh-tool)
[](
https://fabcity.hamburg/)
[](
https://opensourceecology.de)
A command line tool for Open Source Hardware (OSH)
technical project linting (quality assessment).
[Download binaries](https://hoijui.github.io/osh-tool/)
(latest build, Linux & Windows, 64bit)
What it can do:
- Check for (non standardized) OSH project design compliance
- Create human-readable reports
- Create machine-readable reports
## Examples
### Badges
To be used at the top of a README:
- [](
https://hoijui.github.io/MeditationBench/osh-report.html)
- [](
https://osegermany.github.io/AgroCircle/osh-report.html)
- [](
)
- [](
)
- [](
)
- [](
)
### Example Projects
Two sample hardware projects,
using this tool to check their own Open Source'ness
with the help of this tool,
executed in [CI](https://en.wikipedia.org/wiki/Continuous_integration).
The generated report is linked to form the README in a badge
(image after the title) with the text "OSH Report".
| CI Type | Sample Project Hosting | Generated Report | CI Script |
| --- | ------ | --- | --- |
| GitHub Actions | | [Generated Report](https://hoijui.github.io/MeditationBench/osh-report.html) | [.github/workflows/check.yml](https://github.com/hoijui/MeditationBench/blob/master/.github/workflows/check.yml) |
| GitHub Actions 2 | | [Generated Report](https://osegermany.github.io/AgroCircle/osh-report.html) | [.github/workflows/check.yml](https://github.com/osegermany/AgroCircle/blob/master/.github/workflows/check.yml) |
| GitLab CI | | [Generated Report](https://osegermany.gitlab.io/ohloom/osh-report.html) | [.gitlab-ci.yml](https://gitlab.com/OSEGermany/ohloom/-/blob/master/.gitlab-ci.yml) |
## Features
So far, It may only check/lint OSH projects,
while later it is supposed to also initialize them
with all sorts of standard files and tooling.
See [src/checks](src/checks) for the currently supported checks,
including at least:
* Check README existence
* Check LICENSE existence
* Check [okh.toml](https://github.com/OPEN-NEXT/OKH-LOSH/blob/master/OKH-LOSH.ttl)
([Open Know-How](https://openknowhow.org) OSH meta-data file) existence
## Requires
To compile:
* Nim and Nimble, version 0.10.0 or higher
## Install
### From repository
```sh
# Fetch the whole source code
git submodule update --init --recursive
# Latest released version
nimble install osh
# Latest developmental state inside git repository
nimble install osh@#head
```
### From local sources
For example when using a local git clone.
```sh
nimble build
./osh --help
```
## Usage
Simply run `osh -h` to see usage information.
For more details how to use it locally and on CI/build-bot,
see the [**user documentation**](doc/user/README.md).
## Community
Ask anything as an [issue](https://github.com/hoijui/osh-tool/issues/)!
## Similar Projects
We are not just standing on the shoulders of giants,
but also toe on toe with them!
These are two of our big sister projects.
They are similar both in spirit
and in the way they are used on the command-line.
They also work well in combination with this tool.
* [`git`](https://git-scm.com/) -
Master of history
* [`reuse`](https://git.fsfe.org/reuse/tool) -
Handles all things regarding licensing of a project and its sources
## License
GNU Affero General Public License version 3
## Funding
This project was funded by:
* the European Union's [Horizon 2020](
https://research-and-innovation.ec.europa.eu/funding/funding-opportunities/funding-programmes-and-open-calls/horizon-2020_en)
research and innovation program,
under grant agreement no. 869984,
in the context of the [OPEN!NEXT Project](https://opennext.eu/),
from June 2021 (project start)
until November 2021.
* the European Regional Development Fund (ERDF)
in the context of the [INTERFACER Project](https://www.interfacerproject.eu/),
from December 2021
until March 2023.
