Skip to content

Commit 4069ad3

Browse files
authored
docs: 📝 add DOI to CITATION and as a badge (#176)
# Description Officially published template 🎉 so adds the DOI to the repo. This PR needs a quick review. ## Checklist - [x] Updated documentation - [x] Ran `just run-all`
1 parent 58f5c3a commit 4069ad3

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ authors:
1717
given-names: Marton
1818
affiliation: "Steno Diabetes Center Aarhus"
1919
cff-version: 1.2.0
20-
# doi:
21-
# date:
20+
doi: 10.5281/zenodo.17018496
21+
date-released: 2025-09-01
2222
keywords:
2323
- "copier template"
2424
- "template"

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
# Template Python Package: An opinionated setup for making Python packages
44

5-
<!-- [![DOI]()]() -->
6-
5+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17018496.svg)](https://doi.org/10.5281/zenodo.17018496)
76
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
87
[![GitHub
98
License](https://img.shields.io/github/license/seedcase-project/template-python-package.svg)](https://github.com/seedcase-project/template-python-package/blob/main/LICENSE.md)
@@ -66,14 +65,18 @@ effort to create a framework for data management and analysis in
6665
research. If you use this project in your work, please cite it as
6766
follows:
6867

69-
Johnston L.W., Brødbæk S.K., Beicher K., Vago M. Template Python
70-
Package: An opinionated setup for making Python packages URL:
68+
Johnston L.W., Brødbæk S.K., Beicher K., Vago M. (2025). Template Python
69+
Package: An opinionated setup for making Python packages DOI:
70+
10.5281/zenodo.17018496 URL:
7171
https://template-python-package.seedcase-project.org
7272

7373
Or as a BibTeX entry:
7474

7575
@misc{YourReferenceHere,
7676
author = {Johnston, Luke William and Brødbæk, Signe Kirk and Beicher, Kristiane and Vago, Marton},
77+
doi = {10.5281/zenodo.17018496},
78+
month = {9},
7779
title = {Template Python Package: An opinionated setup for making Python packages},
78-
url = {https://template-python-package.seedcase-project.org}
80+
url = {https://template-python-package.seedcase-project.org},
81+
year = {2025}
7982
}

docs/includes/_badges.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- [![DOI]()]() -->
1+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17018496.svg)](https://doi.org/10.5281/zenodo.17018496)
22
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
33
[![GitHub License](https://img.shields.io/github/license/{{< meta gh.org >}}/{{< meta gh.repo >}}.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/blob/main/LICENSE.md)
44
[![GitHub Release](https://img.shields.io/github/v/release/{{< meta gh.org >}}/{{< meta gh.repo >}}.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/releases/latest)

0 commit comments

Comments
 (0)