Skip to content

Commit 7de560a

Browse files
committed
remove code quality service suggestions
1 parent b4ff7f4 commit 7de560a

File tree

1 file changed

+5
-18
lines changed

1 file changed

+5
-18
lines changed

best_practices/language_guides/python.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -140,24 +140,11 @@ If this is not possible or does not fit then use one of the generic code coverag
140140
## Code quality analysis tools and services
141141

142142
Code quality service is explained in the [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html#online-services-providing-software-quality-checks).
143-
There are multiple code quality services available for Python.
144-
There is not a best one, below is a short list of services with their different strenghts.
145-
146-
### [Codacy](https://www.codacy.com)
147-
148-
Code quality and coverage grouped by file.
149-
Can setup goals to improve quality or coverage by file or category.
150-
For example project see https://www.codacy.com/app/3D-e-Chem/kripodb/dashboard.
151-
Note that Codacy does not install your depencencies, which prevents it from correctly identifying import errors.
152-
153-
### [Sonarcloud](https://sonarcloud.io/)
154-
Provides reports similar to Codacy, but can be run from CI (e.g. GitHub Actions), which allows you to install dependencies yourself and thus provide a more complete coverage.
155-
This is currently the default choice in our [Python template](https://github.com/NLeSC/python-template).
156-
157-
### [Scrutinizer](https://scrutinizer-ci.com/)
158-
159-
Code quality and coverage grouped by class and function.
160-
For example project see https://scrutinizer-ci.com/g/NLeSC/eEcology-Annotation-WS/
143+
There are multiple code quality services available for Python, all of which have their pros and cons.
144+
See [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-resources.html) for links to lists of possible services.
145+
We currently setup [Sonarcloud](https://sonarcloud.io/) by default in our [Python template](https://github.com/NLeSC/python-template).
146+
To reproduce the Sonarcloud pipeline locally, you can use [SonarLint](https://www.sonarlint.org/) in your IDE.
147+
If you use another editor, perhaps it is more convenient to pick another service like Codacy or Codecov.
161148

162149

163150
## Debugging and profiling

0 commit comments

Comments
 (0)