You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: best_practices/language_guides/python.md
+5-18Lines changed: 5 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,24 +140,11 @@ If this is not possible or does not fit then use one of the generic code coverag
140
140
## Code quality analysis tools and services
141
141
142
142
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.
0 commit comments