In GitLab by @hoijui on Dec 22, 2022, 09:51

In GitLab by @hoijui on Dec 22, 2022, 09:52

There would have to be exceptions, like other README*.md, LICENSE*.md and index.md files, probably.

In GitLab by @pieterhijma on Feb 6, 2023, 12:29

I can't build on latest Arch Linux. I don't know if that's relevant.

These are the error messages:

/home/pieter/osh-tool/src/checks.nim(11, 10) template/generic instantiation of `importAll` from here
/home/pieter/osh-tool/src/checks/clean_cad_files.nim(19, 22) template/generic instantiation of `parseInjectExtsAndMap` from here
/usr/lib/nim/pure/collections/tables.nim(301, 15) Error: cannot instantiate: 'A'
     Error: Build failed for package: osh_tool
        ... Execution failed with exit code 1
        ... Command: /usr/bin/nim c --colors:on --noNimblePath -d:NimblePkgVersion=0.2.0 --path:/home/pieter/.nimble/pkgs/csvtools-0.2.1 --path:/home/pieter/.nimble/pkgs/docopt-0.7.0 --path:/home/pieter/.nimble/pkgs/regex-0.20.1 --path:/home/pieter/.nimble/pkgs/unicodedb-0.11.2 --path:/home/pieter/.nimble/pkgs/shell-0.5.2 --path:/home/pieter/.nimble/pkgs/regex-0.20.1 --path:/home/pieter/.nimble/pkgs/unicodedb-0.11.2 --path:/home/pieter/.nimble/pkgs/result-0.3.0 -o:/home/pieter/osh-tool/build/osh /home/pieter/osh-tool/src/main.nim

In GitLab by @julianstirling on Feb 25, 2022, 17:21

Consider making the check case non-specific

This is specifically tailored for electronics projects!

KEY

• S = Schematic
• P = PCB
• F = Firmware and/or software
• M = Mechanical CAD files
• D = Design Documentation
• B = Bill Of Materials
• C = License used allows for commercial use

We might want to remake this logo using the clean OSH logo as a base.

Logo generator (for reference):
https://maciek134.github.io/oshw-logo-gen/

Original post (including link to video explanation):
https://www.eevblog.com/oshw/

Forum thread:
https://www.eevblog.com/forum/blog/eevblog-921-open-source-hardware-problems-solved!/

As stated by @jcolomb in #14.

I agree.
Consequently the same applies to the updater (osh update)

If implemented, this would make #8 obsolete.

In GitLab by @hoijui on May 30, 2022, 11:11

... or not, e.g. a Software project, or just text or documentation of something else.

Maybe if no electronics files, no CAD files, no BoM and no OKH manifest is found,
assume it is not a hardware project?

Given a project repository (local checkout),
we would generate an okh.toml manifest file,
with as much data as we manage to gather automatically.
The remaining fields may be:

1. omitted,
2. added with placeholder values
   (like "TODO" or "https://TODO.com/YOUR_ORG/YOUR_REPO/")
3. same as 2., but commented out

NOTE:

• Use projvar to gather lots of the required info
• Use this suggestion
  to figure out [[part]]s of the project

In GitLab by @julianstirling on May 18, 2022, 12:57

Merges typos-in-usage -> master

... according to https://gitlab.fabcity.hamburg/software/template-osh-repo-structure-minimal/

• file suffixes and their meta-data
• ???

The overall compliance is calculated by taking the average, weighted compliance factor
over all executed checks.
We see how this is done in Over all Checks.

Each checks compliance factor is calculated in two separate parts,
which are then combined into one (by multiplication):

Single Check Compliance

1. The first part indicates the overall state of the check-result:
   1. 100% for Perfect
   2. 80% for Ok
   3. 60% for Acceptable
   4. 0% for everything else
2. The second part tracks the issues.
   Starting with the whole 100% in case of no issue,
   and subtracting this high a percentage for each issue
   (regarding its severity level):
   1. High: 30% for the first issue, and then halving that consecutively (15% for the second, 7.5% for the third, ...)
   2. Middle: 15% for the first issue, and then halving that consecutively (7.5% for the second, 3.75% for the third, ...)
   3. Low: 7.5% for the first issue, and then halving that consecutively (3.75% for the second, 1.875% for the third, ...)

Examples:

Check X has final status Acceptable,
two High issues and one Low issue:

80% * (100 - (30+15 + 7.5))% = (0.8 * 47.5)% = 38%
CheckX_compliance_percent = 38
CheckX_compliance_factor = 0.38

The code for this can be found in procedure CheckRes.calcCompliance()
in src/checker.nim.

Over all Checks

For our example, we assume that there are only three checks,
with these names and sub-rating weights:

These are fixed values, defined in the source code.
They are not dependent on the project the test is run on.

To get the final ratings used later on,
we multiply all the sub-rating factors
(marked with _ in the table above)
with the weight, and use the weight for the overall compliance weight;
thus we get this table of weights:

The Sum indicates the maximum Sum achievable by any project,
so this is our 100%.
We will use this table from now on.

Now we run the checks on a specific ProjectA,
and we get these compliance factors
(for this example, these are random numbers),
as described in Single Check Compliance.

We multiply these values with the table we calculated before,
row by row, and get:

... to identify what kind/category of hardware a part is.
more info in this issue:
https://github.com/OPEN-NEXT/OKH-LOSH/issues/134

Using e.g. the style CLI tool from the Linux/Debian package diction.

NOTE: This probably makes little sense: Do this at the very end, you know.. when the software is perfect already, otherwise.

In GitLab by @moedn on Sep 15, 2021, 15:20

based on the discussion here

we need a CSV file with the following columns:

• file extension
• open/closed format?
• binary or plain text?

→ for all (popular) CAD formats; which is everything in this list plus:

• FreeCAD
• openSCAD
• QCAD
• LibreCAD
• CadQuery

I get the following error when I try to run from the binary.

$ ./osh -h
    ./osh: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.33' not found (required by ./osh)
    ./osh: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.34' not found (required by ./osh)

Some debug info:

$ ldd --version
    ldd (Ubuntu GLIBC 2.31-0ubuntu9.9) 2.31
    Copyright (C) 2020 Free Software Foundation, Inc.
    This is free software; see the source for copying conditions.  There is NO
    warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    Written by Roland McGrath and Ulrich Drepper.

Each check should describe its self,
and then the tool collects the names and descriptions
and generates a human-readable description of all the checks.

• Markdown
• JSON
• support output to file instead of (only) stdout

In GitLab by @julianstirling on Feb 25, 2022, 17:20

Running documentation is missing. I can run -h but there is little information on what I am expecting each sub-command to do, or even any context for what the entire program aims to do.

In GitLab by @julianstirling on Feb 25, 2022, 17:28

A scad file is an openscad source file, it is text based and should be expected in open source repositories.

In GitLab by @moedn on Dec 2, 2021, 12:48

Hey ho, just tested the tool on OHLOOM; this is the result of

./osh -C <path-to-OHLOOM-repo> check

- [ ] No space in file names
  - LIGHT - Files with spaces in their names (Please consider renaming them):
    
    * fatal: not a git repository (or any parent up to mount point /)
    * Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
    * fatal: not a git repository (or any parent up to mount point /)
    * Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
- [ ] README exists
  - MIDDLE - No README file found in the root directory.
    Please consider adding a 'README.md'.
    You might want to generate a template by issuing `osh init --readme`,
    or manually reating it.
- [ ] LICENSE exists
  - HEAVY - No LICENSE (or COPYING) file found in the root directory.
    Please consider adding a LICENSE(.md).
    You might want to choose one from a list by issuing `osh init --license`.
- [x] Might be generated
- [x] OKH file exists
DBG 2021-12-02 12:45:11.542+01:00 Skip reporting check because it is inapplicable to this project (in its current state) tid=355626 checkName="Clean electronics files"
- [x] No unwanted files
- [x] No sources in root

I very much like the output format :) However I did expect an outcome stating:

• that the README exists
• that a (hardware-specific) license exists
• that export files are in the repo ← shouldn't be there

Not sure how much sense this check would make, as each repo will likely have a REAME.md in the top, and thus this would always check as true.
Maybe we could exclude the repo root dir as counting as tree head? That would often be wrong, though.

• LICENSE.md
• LICNESES/
• README.md
• .reuse/dep5
• ... anything else?

I downloaded the current binary for Linux so that I could do a trial run against one of my open hardware repos. When I run it I get an error about projvar not being in the path. I don't see anything about that in the readme. What am I missing?

$ /home/jwright/Downloads/osh-0708717-x86_64-linux/osh check
DEBUG Running projvar ...
DEBUG Now running 'projvar' ...
/home/runner/work/osh-tool/osh-tool/src/main.nim(268) main
/home/runner/work/osh-tool/osh-tool/src/main.nim(201) cli
/home/runner/work/osh-tool/osh-tool/src/tools.nim(239) runProjvar
Error: unhandled exception: Failed to run 'projvar'; make sure it is in your PATH: Additional info: Could not find command: 'projvar'. OS error: No such file or directory [IOError]

As in: gather them in the Nim code, and add them to whatever report formats output that is chosen (at least JSON and Markdown).

As of now, it is only collected in the BASH script that generates the HTML report.

This idea could be spun further, to .. in the end generate the whole HTML report - as is now generated in the BASH script - form Nim code.

This would be a combined test, with 0 importance, made up of other tests (some of which we already have).

Deprecated, original website:
https://opensourcedesign.cc/wiki/index.php/Open-O-meter

The paper:
https://www.sciencedirect.com/science/article/pii/S2212827118312095

In English:
https://www.appropedia.org/Open-o-Meter

In German:
https://de.oho.wiki/wiki/Open-o-Meter

In GitLab by @hoijui on May 25, 2022, 11:42

In GitLab by @moedn on Sep 8, 2021, 14:29

…needs to happen manually (e.g. on Zenodo) until this issue is resolved.

We could also get a badge for the DOI like here

In GitLab by @hoijui on May 30, 2022, 11:12

tip from Raphael@FCHH

Checks can themselves decide that they are not applicable to a repo.
If they decide they are not, the user gets a generic message about that finding.
IT would be better to have a per-check specific message,
about why it was skipped.
This could technically be done similarly like the error messages.

This is especially interesting for output formats other then the default (Markdown list),
where it is only a DEUBG level log message.
In other formats, it could end up being directly in the output
(eg. a skip-message field).

Current example:

DEBUG Skip reporting check 'Clean electronics files', because it is inapplicable to this project (in its current state)

In GitLab by @jcolomb on Jun 23, 2022, 12:34

hi,
I like the idea to have a check for a OSH repo, I do think it will only be used if it can be a GitHub action and/or gitlab CI.

PS: I would keep a repo creator tool outside of this one.

... and if not,
give a bad score, but with a very low weight

Use a natural language detection library for this,
feeding it all the clear-text extracted from all the Markdown files.
I found no such library for Nim, but here is one for rust:
https://crates.io/crates/lingua
... so maybe we should use it through CLI invocation as well?

Warum
Wie
Wozu

allgemein und fuer jeden check

verlinken auf eine beschriebung fuer jeden check

unter Example projects im README: noch beschreiben wie genau man das benutzt:
"Wenn GitLab, dann datei kopieren, pushen, und dann kommt output im CI tab deines projekts, und erscheint auf deinen pages"

In GitLab by @julianstirling on Feb 25, 2022, 17:23

This links to #6. I am not really sure the goal of init, but it seems strange that it exits with an error when a single file exists?

In GitLab by @hoijui on Oct 27, 2022, 21:30

In GitLab by @moedn on Sep 15, 2021, 15:07

osh check

done on OHLOOM

returns

Check - OKH file exists? - Failed: Open Know-How meta-data file (^okh.toml$) not found. Please consider using the assistant (osh okh), or manually reating it. See <TODO-OKHv2-URL> for more information about OKH.

In GitLab by @julianstirling on Feb 25, 2022, 17:27

SVG is the native file format of Inkscape and is a valid source file. It should not be flagged as a generated file.

Similarly jpg files are generally photos which if they are in documentation the cannot be generated by a CI. Similarly some PNGs (for example high resolution renders) also generally takes specialist computing hardware and cannot be generated on-the-fly by a CI.