Skip to content

Commit 40804ee

Browse files
authored
Add Citation and Zenodo metadata (#25)
* Add citation file for easier reference * releasing v1.0.0, set date * Add JSON file for metadata tracking with Zenodo and test to validate it
1 parent ab0bb8d commit 40804ee

File tree

4 files changed

+101
-1
lines changed

4 files changed

+101
-1
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Check zenodo metadata
2+
3+
on: [push]
4+
5+
jobs:
6+
check-zenodo-metadata:
7+
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-node@v4
13+
with:
14+
node-version: '22'
15+
- name: Install dependencies
16+
run: npm install zenodraft@0.14.1
17+
- name: Check .zenodo.json file
18+
run: |
19+
npx zenodraft metadata validate .zenodo.json

.zenodo.json

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"creators": [
3+
{
4+
"name": "Thompson, Matthew J.",
5+
"orcid": "0000-0003-0583-8585"
6+
},
7+
{
8+
"name": "Campolongo, Elizabeth G.",
9+
"orcid": "0000-0003-0846-2413"
10+
},
11+
{
12+
"name": "Duan, Zoe",
13+
"orcid": "0000-0002-8547-5907"
14+
},
15+
{
16+
"name": "Lapp, Hilmar",
17+
"orcid": "0000-0001-9107-0714"
18+
}
19+
],
20+
"description": "A command-line package to generate CSV with filepath, filename, checksum for all contents of given directory.",
21+
"keywords": [
22+
"imageomics",
23+
"metadata",
24+
"CSV",
25+
"images",
26+
"verifier",
27+
"checksums",
28+
"file-verification",
29+
"deduplication"
30+
],
31+
"license": {
32+
"id": "MIT"
33+
},
34+
"publication_date": "2025-04-03",
35+
"title": "Sum Buddy",
36+
"version": "1.0.0",
37+
"grants": [
38+
{
39+
"id": "021nxhr62::2118240"
40+
}
41+
]
42+
}

CITATION.cff

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
abstract: "A command-line package to generate CSV with filepath, filename, checksum for all contents of given directory."
2+
authors:
3+
- family-names: "Thompson"
4+
given-names: "Matthew J."
5+
orcid: "https://orcid.org/0000-0003-0583-8585"
6+
- family-names: "Campolongo"
7+
given-names: "Elizabeth G."
8+
orcid: "https://orcid.org/0000-0003-0846-2413"
9+
- family-names: "Zoe"
10+
given-names: "Duan"
11+
orcid: "https://orcid.org/0000-0002-8547-5907"
12+
- family-names: "Lapp"
13+
given-names: "Hilmar"
14+
orcid: "https://orcid.org/0000-0001-9107-0714"
15+
cff-version: 1.2.0
16+
date-released: "2025-04-03"
17+
identifiers:
18+
- description: "The GitHub release URL of tag v1.0.0."
19+
type: url
20+
value: "https://github.com/Imageomics/sum-buddy/releases/tag/v1.0.0"
21+
- description: "The GitHub URL of the commit tagged with v1.0.0."
22+
type: url
23+
value: "https://github.com/Imageomics/sum-buddy/tree/<commit hash>" #update on release
24+
keywords:
25+
- imageomics
26+
- metadata
27+
- CSV
28+
- images
29+
- verifier
30+
- checksums
31+
- file-verification
32+
- deduplication
33+
license: MIT
34+
message: "If you use this software, please cite it using the metadata from this file."
35+
repository-code: "https://github.com/Imageomics/sum-buddy"
36+
title: "Sum Buddy"
37+
version: "1.0.0"
38+
# doi: <DOI from Zenodo>
39+
type: software

src/sumbuddy/__about__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.2.0-alpha"
1+
__version__ = "1.0.0"

0 commit comments

Comments
 (0)