Skip to content

Commit e83e292

Browse files
authored
Merge pull request #262 from NLeSC/python_quality_services
update code quality services (for Python)
2 parents d56210d + 7de560a commit e83e292

File tree

5 files changed

+11
-26
lines changed

5 files changed

+11
-26
lines changed

best_practices/code_quality.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Code Quality
22

3-
Ways to improve code quality are in the [Code quality](https://the-turing-way.netlify.app/code_quality/code_quality.html) chapter on the Turing Way.
3+
Ways to improve code quality are in the [Code quality](https://the-turing-way.netlify.app/reproducible-research/code-quality.html) chapter on the Turing Way.
44

5-
There are [online software quality improvement tools](https://the-turing-way.netlify.app/code_quality/code_quality.html#Online-services-providing-software-quality-checks) see the [language guides](language_guides/languages_overview.md) for good options per language.
5+
There are [online software quality improvement tools](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html#online-services-providing-software-quality-checks) see the [language guides](language_guides/languages_overview.md) for good options per language.
66

77
## Editorconfig
88

best_practices/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ file describes at least how to perform the following tasks:
8888

8989
* How to [install the dependencies](#documented-development-setup)
9090
* How to run [(unit) tests](testing.md#unit-tests)
91-
* What [code style](https://the-turing-way.netlify.app/code_quality/code_quality.html#Code-style) to use
91+
* What [code style](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html) to use
9292
* Reference to [code of conduct](#code-of-conduct)
9393
* When using a [git branching model](version_control.md#choose-one-branching-model), the choice of branching model
9494

best_practices/language_guides/python.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -140,28 +140,13 @@ If this is not possible or does not fit then use one of the generic code coverag
140140

141141
## Code quality analysis tools and services
142142

143-
Code quality service is explained in the [The Turing Way](https://the-turing-way.netlify.app/code_quality/code_quality.html#Online-services-providing-software-quality-checks).
144-
There are multiple code quality services available for Python.
145-
There is not a best one, below is a short list of services with their different strenghts.
143+
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).
144+
There are multiple code quality services available for Python, all of which have their pros and cons.
145+
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.
146+
We currently setup [Sonarcloud](https://sonarcloud.io/) by default in our [Python template](https://github.com/NLeSC/python-template).
147+
To reproduce the Sonarcloud pipeline locally, you can use [SonarLint](https://www.sonarlint.org/) in your IDE.
148+
If you use another editor, perhaps it is more convenient to pick another service like Codacy or Codecov.
146149

147-
### [Codacy](https://www.codacy.com)
148-
149-
Code quality and coverage grouped by file.
150-
Can setup goals to improve quality or coverage by file or category.
151-
For example project see https://www.codacy.com/app/3D-e-Chem/kripodb/dashboard.
152-
Note that Codacy does not install your depencencies, which prevents it from correctly identifying import errors.
153-
154-
### [Scrutinizer](https://scrutinizer-ci.com/)
155-
156-
Code quality and coverage grouped by class and function.
157-
For example project see https://scrutinizer-ci.com/g/NLeSC/eEcology-Annotation-WS/
158-
159-
### [Landscape](https://landscape.io)
160-
161-
Dedicated for Python code quality.
162-
Celery, Django and Flask specific behaviors.
163-
The Landscape analysis tool called [`prospector`](https://github.com/landscapeio/prospector) can be run locally.
164-
For example project see https://landscape.io/github/NLeSC/MAGMa
165150

166151
## Debugging and profiling
167152

best_practices/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ At the Netherlands eScience Center we require minimum of 70% coverage.
5757
Setting up code coverage for a repository depends on the programming language, see the [language specific guides](language_guides/languages_overview.md) for setup instructions.
5858

5959
The code coverage should be performed when a test suite is run as part of Continuous Integration build job.
60-
The code coverage results can be published on code coverage and/or [code quality services](https://the-turing-way.netlify.app/code_quality/code_quality.html#Online-services-providing-software-quality-checks).
60+
The code coverage results can be published on code coverage and/or [code quality services](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html#online-services-providing-software-quality-checks).
6161

6262
### Code coverage services
6363

nlesc_specific/checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The [checklist matrix](./checklist_matrix.md) provides an indication of which it
4040
## [Code Quality](../best_practices/code_quality.md)
4141

4242
- [use editorconfig](../best_practices/code_quality.md#use-editorconfig)
43-
- [code style applied in automated way](https://the-turing-way.netlify.app/code_quality/code_quality.html#Automatic-formatting)
43+
- [code style applied in automated way](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html#automatic-formatting)
4444

4545
## [Testing](../best_practices/testing.md)
4646

0 commit comments

Comments
 (0)