Skip to content

scientificcomputing/repo-review

Repository files navigation

Simula Repo Review

Tool to review repositories for compliance with Simula's repository policies. See https://simulink.simula.no/policy/56 for more information.

Installation

Run the package with directly with UV

uvx simula-repo-review gh:<org>/<repo>@<branch> --select "SI"

Or install via pip:

python3 -m pip install simula-repo-review

Run checks

If you do not use uv you can omit the uvx part and run the simula-repo-review command directly after installation.

Run only the Simula checks:

uvx simula-repo-review gh:<org>/<repo>@<branch> --select "SI"

for example

uvx simula-repo-review gh:ComputationalPhysiology/cardiac-geometries@main --select "SI"

Run all checks:

uvx simula-repo-review gh:<org>/<repo>@<branch>

for example

uvx simula-repo-review gh:ComputationalPhysiology/cardiac-geometries@main

Run simula and python checks:

uvx simula-repo-review gh:<org>/<repo>@<branch> --select "SI,PY,PP"

for example

uvx simula-repo-review gh:ComputationalPhysiology/cardiac-geometries@main --select "SI,PY,PP"

Learn more

You can read more about the Simula repository policies at https://simulink.simula.no/policy/56. To learn more about repo-review, visit https://repo-review.readthedocs.io/en/latest/.

License

MIT

About

Tool to review repositories for compliance with Simula's repository policies.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages