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: README.md
+60-63Lines changed: 60 additions & 63 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,27 @@
1
1
# Netherlands eScience Center Python Template
2
2
3
-
Spend less time setting up and configuring your new Python packages and comply with the
4
-
[Netherlands eScience Center Software Development Guide](https://guide.esciencecenter.nl/)
5
-
from the start.
3
+
Spend less time setting up and configuring your new Python packages and comply with the [Netherlands eScience Center Software Development Guide](https://guide.esciencecenter.nl/) from the start.
6
4
7
-
Use this [Cookiecutter](https://cookiecutter.readthedocs.io) template to generate
8
-
an empty Python package. Features include:
5
+
Use this [Copier](https://copier.readthedocs.io) template to generate an empty Python package. Features include:
- Continuous integration with [GitHub action workflows]({{cookiecutter.directory_name}}/.github/workflows) for building, testing, link checking and linting,
10
+
- Continuous integration with [GitHub action workflows]({{directory_name}}/.github/workflows) for building, testing, link checking and linting,
14
11
- Code style checking with [ruff](https://beta.ruff.rs/),
- Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/),
24
-
- Automatic creation of [issues]({{cookiecutter.directory_name}}/.github/next_steps) with instructions how to pass all GitHub action workflows and integrate with services like Zenodo and Read the Docs,
25
-
- Instructions how to make package [citable]({{cookiecutter.directory_name}}/.github/next_steps/02_citation.md)
21
+
- Automatic creation of [issues]({{directory_name}}/.github/next_steps) with instructions how to pass all GitHub action workflows and integrate with services like Zenodo and Read the Docs,
22
+
- Instructions how to make package [citable]({{directory_name}}/.github/next_steps/02_citation.md)
26
23
- FAIR software recommendation badge,
27
-
- Optional [pre commit hook]({{cookiecutter.directory_name}}/README.dev.md#running-linters-locally) to catch lint errors early
24
+
- Optional [pre commit hook]({{directory_name}}/README.dev.md#running-linters-locally) to catch lint errors early
28
25
29
26
## Badges
30
27
@@ -45,24 +42,21 @@ an empty Python package. Features include:
45
42
46
43
## How to use
47
44
48
-
### Step 1/3: Install `cookiecutter`
49
-
50
-
We recommend installing `cookiecutter` in user space as per `cookiecutter`'s instructions. This way, you don't have to
0 commit comments