Review repos for compliance to the Scientific-Python development guidelines
Project description
sp-repo-review
[![GitHub Discussion][github-discussions-badge]][github-discussions-link] [![Live ReadTheDocs][rtd-badge]][rtd-link]
sp-repo-review
provides checks based on the Scientific-Python Development
Guide at scientific-python/cookie.
This tool can check the style of a repository. Use like this:
pipx run 'sp-repo-review[cli]' <path to repository>
This will produce a list of results - green checkmarks mean this rule is followed, red x’s mean the rule is not. A yellow warning sign means that the check was skipped because a previous required check failed. Some checks will fail, that’s okay - the goal is bring all possible issues to your attention, not to force compliance with arbitrary checks. Eventually there might be a way to mark checks as ignored.
For example, GH101
expects all your action files to have a nice name:
field.
If you are happy with the file-based names you see in CI, you should feel free
to simply ignore this check (just visually ignore it for the moment, a way to
specify ignored checks will likely be added eventually).
All checks are mentioned at least in some way in the Scientific-Python
Development Guide. You should read that first - if you are not attempting to
follow them, some of the checks might not work. For example, the guidelines
specify pytest configuration be placed in pyproject.toml
. If you place it
somewhere else, then all the pytest checks will be skipped.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sp_repo_review-2023.6.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 250dc7a0e3b2cd1394bf45c9e8336d4ab49ab8c12785315c4927da923437777d |
|
MD5 | 9b0f06177bd3bbaadff4ff2d714ea9e4 |
|
BLAKE2b-256 | 9b27cb9129a05912fc8e392c8091df70f7c8f606f3eb7314a2578707bd754f20 |