nimble - OSH quality report

Produced by the osh-tool

OSH - compliance
OSH - openness
OSH - hardware
OSH - quality
OSH - machineReadability

This report in different formats

Project meta-data

version 11c75c343f7330098a7ef01544d92a1bfe51f512
version release date 2023-03-14 07:50:43
branch master
report build date 2023-03-14 07:52:57
licenses AGPL-3.0-or-later, Apache-2.0, CC-BY-4.0, CC-BY-SA-4.0, CC0-1.0, CERN-OHL-S-2.0, OFL-1.1, Unlicense

Report tools

CLI tool version
osh 0.3.0-7-g0708717
okh 0.4.3-4-g8220305
reuse 1.0.0
projvar 0.16.1-2-g09106cc
mle 0.22.0-13-ga80b12a
osh-dir-std 0.5.0-8-g6ad2db3

Report

Passed Status Compliance Factor Weight Weighted Comp. Fac. Check Severity - Issue
Perfect 1.00 0.70 0.70 OKH file exists
Perfect 1.00 0.20 0.20 LICENSE exists
Perfect 1.00 0.20 0.20 README exists
Perfect 1.00 0.50 0.50 No unwanted files
Perfect 1.00 0.40 0.40 No space in file names
Perfect 1.00 0.40 0.40 No global links to local files
Perfect 1.00 0.50 0.50 REUSE/SPDX Licensing info
Ok 0.68 1.00 0.68 Uses dir standard Middle - Compliance factor 0.94 is not perfect, but close, being above the upper expected factor of 0.9
Perfect 1.00 0.70 0.70 OKH manifest content
Perfect 1.00 0.10 0.10 No sources in root
Bad 0.00 0.50 0.00 Might be generated Low - Possibly generatable files found. Please consider removing them:
 
  - src/mech/cadquery_workflow/autodoc_integration/img/autodoc_sample.pdf
  - src/mech/cadquery_workflow/autodoc_integration/img/cc.pdf
  - src/mech/cadquery_workflow/autodoc_integration/img/duration.pdf
  - src/mech/cadquery_workflow/autodoc_integration/img/remark.pdf
  - src/mech/cadquery_workflow/autodoc_integration/img/screwdriver-phillips.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/allen-key.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/cable-ties.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/calibrate-mirror-angle.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/cc.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/duration.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/hold-mirror.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/howto-title-img.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/howto.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/insert-mirror.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/insert-t-nut-allen-key.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/insert-t-nut-slide.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/insert-t-nut.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/laser-path.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/locknuts-direction.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/locknuts.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/mirror-insert-ring.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/mirror-remove-ring.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/moist-tube.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/remark.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/remove-excess-teflon-tape.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/set-screws.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/slide-tube.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-1-detail.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-1-parts/b-screw-m6-12.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-1-parts/bracket-30.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-1-parts/profile-30-770.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-1-parts/profile-30-800.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-1-parts/t-nut-m6.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-1.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-2.1-detail-1-001.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-2.1-detail-2-001.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-2.1-parts/b-screw-m6-12.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-2.1-parts/bracket-30.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-2.1-parts/profile-30-350.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-2.1-parts/profile-30-380.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-2.1-parts/t-nut-m6.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/step-2.1.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/template-1.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/tighten-belt.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/titlepage.pdf
  - src/mech/cadquery_workflow/res/fabulaser-manual/img/wrap-teflon-tape.pdf
  - src/mech/cadquery_workflow/res/scripts/is-svg-to-pdf
  - src/mech/cadquery_workflow/res/template/img/cc.pdf
  - src/mech/cadquery_workflow/res/template/img/duration.pdf
  - src/mech/cadquery_workflow/res/template/img/remark.pdf
  - src/mech/cadquery_workflow/res/template/img/screwdriver-phillips.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/1-align-the-base-parts/base001.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/2-attach-the-block-parts/block001.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/2-attach-the-block-parts/m8x50.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/3-attach-the-fixed-jaw-parts/fixed-jaw001.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/3-attach-the-fixed-jaw-parts/m8x50.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/4.1-align-the-sliding-jaw-parts/sliding-jaw001.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/4.2-attach-the-sliding-jaw-parts/end-plate001.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/4.2-attach-the-sliding-jaw-parts/m8x25.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/5-insert-the-screw-parts/screw001.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/6-attach-the-handle-parts/handle001.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/cc.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/duration.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/remark.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/screwdriver-phillips.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-1.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-2.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-3.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-4.1-highlight.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-4.1.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-4.2-highlight.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-4.2.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-5.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/step-6.pdf
  - src/mech/cadquery_workflow/res/vise-manual/img/titlepage.pdf
Perfect 1.00 1.00 1.00 Clean CAD files
10.68/0.89 6.20/0.52 10.41/0.87 Sum/Average

Project Statistics

Property Value
Checks Run 12
Checks Skipped 1
Checks Passed 11
Checks Failed 1
Checks Available 13
Issues High 0
Issues DeveloperFailure 0
Issues Low 2
Issues Middle 1
Compliance 86.77% -
Openness 88.77% -
is hardware (factor) 0.95
Quality 85.57% -
Machine-Readability 91.00% -

Project meta-data (by projvar)

key value
VERSION_DATE 2023-03-14 07:50:43
BUILD_BRANCH master
REPO_RAW_VERSIONED_PREFIX_URL https://raw.githubusercontent.com/hoijui/nimble
REPO_CLONE_URL https://github.com/hoijui/nimble
NAME_MACHINE_READABLE nimble
REPO_CLONE_URL_HTTP https://github.com/hoijui/nimble.git
BUILD_ARCH x86_64
BUILD_DATE 2023-03-14 07:52:57
BUILD_HOSTING_URL https://hoijui.github.io/nimble
REPO_COMMIT_PREFIX_URL https://github.com/hoijui/nimble/commit
REPO_VERSIONED_DIR_PREFIX_URL https://github.com/hoijui/nimble/tree
LICENSES AGPL-3.0-or-later, Apache-2.0, CC-BY-4.0, CC-BY-SA-4.0, CC0-1.0, CERN-OHL-S-2.0, OFL-1.1, Unlicense
LICENSE CERN-OHL-S-2.0
REPO_ISSUES_URL https://github.com/hoijui/nimble/issues
BUILD_OS_FAMILY unix
CI true
REPO_VERSIONED_FILE_PREFIX_URL https://github.com/hoijui/nimble/blob
REPO_CLONE_URL_SSH ssh://git@github.com/hoijui/nimble.git
NAME nimble
BUILD_OS Linux
VERSION 11c75c343f7330098a7ef01544d92a1bfe51f512
REPO_WEB_URL https://github.com/hoijui/nimble