Repository navigation
Expand file tree
/
Copy pathREADME.md.jinja
More file actions
70 lines (56 loc) · 4.39 KB
/
Copy pathREADME.md.jinja
File metadata and controls
70 lines (56 loc) · 4.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
## Badges
(Customize these badges with your own links, and check https://shields.io/ or https://badgen.net/ to see which other badges are available.)
| fair-software.eu recommendations | |
| :-- | :-- |
| (1/5) code repository | []({{repository_url}}) |
| (2/5) license | []({{repository_url}}) |
| (3/5) community registry | [](https://www.research-software.nl/software/{{package_name}}) [](https://pypi.python.org/project/{{package_name}}/) |
| (4/5) citation | {% if AddZenodo -%} [](https://doi.org/<replace-with-created-DOI>){%- endif -%} |
| (5/5) checklist | [](https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>) |
| howfairis | [](https://fair-software.eu) |
| **Other best practices** | |
{% if AddSonarCloud -%}
| Static analysis | [](https://sonarcloud.io/dashboard?id={{github_organization}}_{{package_name}}) |
| Coverage | [](https://sonarcloud.io/dashboard?id={{github_organization}}_{{package_name}}) |
{%- endif -%}
{% if AddOnlineDocumentation -%}
| Documentation | [](https://{{package_name}}.readthedocs.io/en/latest/?badge=latest) |
{%- endif -%}
| **GitHub Actions** | |
| Build | []({{repository_url}}/actions/workflows/build.yml) |
{% if AddCitation -%}
| Citation data consistency | []({{repository_url}}/actions/workflows/cffconvert.yml) |
{%- endif -%}
{% if AddSonarCloud -%}
| SonarCloud | []({{repository_url}}/actions/workflows/sonarcloud.yml) |
{%- endif -%}
{% if AddLinkCheck -%}
| Link checker | []({{repository_url}}/actions/workflows/link-check.yml) |
{%- endif -%}
{% if AddTyping -%}
{% if SelectTypeChecker == 'pyright' -%}
| Type checker | [](https://microsoft.github.io/pyright/) |
{%- endif -%}
{% if SelectTypeChecker == 'mypy' -%}
| Type checker | [](http://mypy-lang.org/) |
{%- endif -%}
{%- endif %}
## How to use {{ package_name }}
{{ package_short_description|replace('\"', '\\\"') }}
The project setup is documented in [project_setup.md](project_setup.md). Feel free to remove this document (and/or the link to this document) if you don't need it.
## Installation
To install {{ package_name }} from GitHub repository, do:
```console
git clone {{ repository }}.git
cd {{ package_name }}
python -m pip install .
```
## Documentation
Include a link to your project's full documentation here.
{% if AddContributing -%}
## Contributing
If you want to contribute to the development of {{ package_name }},
have a look at the [contribution guidelines](CONTRIBUTING.md).
{%- endif %}
## Credits
This package was created with [Copier](https://github.com/copier-org/copier) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).