Skip to content

docs: 📝 add DOI to CITATION and as a badge #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 1, 2025
Merged

docs: 📝 add DOI to CITATION and as a badge #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d38080
docs: :memo: add DOI to CITATION and as a badge
lwjohnst86 Sep 1, 2025
d74bd47
Merge branch 'main' into docs/add-badge-for-doi
lwjohnst86 Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ authors:
given-names: Marton
affiliation: "Steno Diabetes Center Aarhus"
cff-version: 1.2.0
# doi:
# date:
doi: 10.5281/zenodo.17018496
date-released: 2025-09-01
keywords:
- "copier template"
- "template"
Expand Down
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

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

<!-- [![DOI]()]() -->

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17018496.svg)](https://doi.org/10.5281/zenodo.17018496)
[![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)
[![GitHub
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)
Expand Down Expand Up @@ -46,6 +45,15 @@ Please note that this project is released with a [Contributor Code of
Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree
to abide by its terms.

### Contributors

These are the people who have contributed by submitting changes through
pull requests :tada:

[@lwjohnst86](https://github.com/lwjohnst86),
[@martonvago](https://github.com/martonvago),
[@signekb](https://github.com/signekb)

## Licensing

This project is licensed under the [MIT License](LICENSE.md).
Expand All @@ -57,14 +65,18 @@ effort to create a framework for data management and analysis in
research. If you use this project in your work, please cite it as
follows:

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

Or as a BibTeX entry:

@misc{YourReferenceHere,
author = {Johnston, Luke William and Brødbæk, Signe Kirk and Beicher, Kristiane and Vago, Marton},
doi = {10.5281/zenodo.17018496},
month = {9},
title = {Template Python Package: An opinionated setup for making Python packages},
url = {https://template-python-package.seedcase-project.org}
url = {https://template-python-package.seedcase-project.org},
year = {2025}
}
1 change: 0 additions & 1 deletion README.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ to abide by its terms.
### Contributors

{{< include /_contributors.qmd >}}
:::

## Licensing

Expand Down
2 changes: 1 addition & 1 deletion docs/includes/_badges.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- [![DOI]()]() -->
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17018496.svg)](https://doi.org/10.5281/zenodo.17018496)
[![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)
[![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)
[![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)
Expand Down
Loading