Skip to content

Commit 2fde7ee

Browse files
authored
docs: add doi to citation.cff and badge to readme (#66)
1 parent 5002ff0 commit 2fde7ee

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

CITATION.cff

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cff-version: 1.2.0
2-
message: "If you use this software, please cite it as below."
2+
message: "If you use python-re3data, please cite it as below."
33
type: software
44
authors:
55
- family-names: Fütterer
@@ -16,5 +16,9 @@ keywords:
1616
- re3data
1717
- repositories
1818
- research data
19+
identifiers:
20+
- description: This is the collection of archived snapshots of all versions of python-re3data
21+
type: doi
22+
value: 10.5281/zenodo.11264510
1923
version: 0.2.0
2024
date-released: 2024-05-23

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1010
| __Docs__ | [![docs][docs-badge]][docs-workflow] |
1111
| __Package__ | [![pypi-status][status-badge]][pypi-url] [![pypi-version][pypi-version-badge]][pypi-url] [![pypi-python-versions][pypi-python-versions-badge]][pypi-url] [![all-downloads][all-downloads-badge]][pepy-tech-url] [![monthly-downloads][monthly-downloads-badge]][pepy-tech-url] |
12-
| __Meta__ | [![OpenSSF Scorecard][scorecard-badge]][scorecard-url] [![hatch][hatch-badge]][hatch] [![ruff][ruff-badge]][ruff] [![mypy][mypy-badge]][mypy] [![License][license-badge]][license-url] |
12+
| __Meta__ | [![doi][doi-badge]][doi-url] [![OpenSSF Scorecard][scorecard-badge]][scorecard-url] [![hatch][hatch-badge]][hatch] [![ruff][ruff-badge]][ruff] [![mypy][mypy-badge]][mypy] [![License][license-badge]][license-url] |
1313

1414
`python-re3data` is a Python library that simplifies interacting with the [re3data](https://www.re3data.org) (Registry
1515
of Research Data Repositories) [REST API](https://www.re3data.org/api/doc), allowing you to easily retrieve and process
@@ -98,6 +98,8 @@ There are a couple of similar projects available on GitHub, e.g. via the topic
9898
[docs-badge]: https://github.com/afuetterer/python-re3data/actions/workflows/docs.yml/badge.svg
9999
[docs-url]: https://afuetterer.github.io/python-re3data
100100
[docs-workflow]: https://github.com/afuetterer/python-re3data/actions/workflows/docs.yml
101+
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.11264510.svg
102+
[doi-url]: https://doi.org/10.5281/zenodo.11264510
101103
[hatch]: https://github.com/pypa/hatch
102104
[hatch-badge]: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg
103105
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg

0 commit comments

Comments
 (0)