raspofabs/spicy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
219 commits 1 branch 0 tags 446 KiB
Find a file
Exact
Richard Fabian 4a9a82312a adding link ignoring
2025-09-21 21:50:19 +01:00
.vscode coverage up 2025-07-05 18:46:59 +01:00
docs update spec 2025-06-29 11:30:02 +01:00
src/spicy adding link ignoring 2025-09-21 21:50:19 +01:00
tests adding link ignoring 2025-09-21 21:50:19 +01:00
.envrc update 2025-04-21 21:58:57 +01:00
.gitignore self check in gitignore 2025-04-05 22:17:20 +01:00
.pre-commit-config.yaml optional writing 2025-07-05 10:42:49 +01:00
.pycln-config.yaml adding pre-commit 2025-03-27 19:13:10 +00:00
.python-version spicy added 2025-02-26 17:06:54 +00:00
pyproject.toml change from bash to python scripts to run tests 2025-07-06 14:44:41 +01:00
README.md docs: update spicy docs and cleanups 2025-04-21 22:11:19 +01:00
run_self_check.py check refs in checks 2025-07-07 17:19:20 +01:00
run_spicy_on_test_data.py check refs in checks 2025-07-07 17:19:20 +01:00
TODO.md update 2025-04-21 21:58:57 +01:00
uv.lock update ruff 2025-07-05 18:41:03 +01:00

README.md

Spicy

Built as a tool to try to automate the tracking of non-compliance when attempting to follow an ASPICE process. Spicy tries to help by letting you know where there are missing documents, missing links, and missing fields in your documentation.

Installation

uv tool install . -e

Operation

Tool configuration is minimal. Either supply the project prefix on the command line or provide a .spicy.yaml config file.

# with prefix
spicy --prefix PRJPREF docs/path

# with a docs/path/.spicy.yaml
spicy docs/path

The configuration is currently only the prefix. Examples can be found in the test data, but also in the Spicy docs directory.

prefix: PROJ