roagg 2025.0.8__tar.gz → 2025.0.9__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- roagg-2025.0.9/PKG-INFO +133 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/pyproject.toml +4 -1
- roagg-2025.0.9/src/roagg.egg-info/PKG-INFO +133 -0
- roagg-2025.0.8/PKG-INFO +0 -6
- roagg-2025.0.8/src/roagg.egg-info/PKG-INFO +0 -6
- {roagg-2025.0.8 → roagg-2025.0.9}/LICENSE +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/README.md +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/setup.cfg +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/__init__.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/__main__.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/aggregator.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/cli.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/helpers/ror.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/helpers/utils.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/models/research_output_item.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/providers/datacite.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/providers/openaire.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg/providers/openalex.py +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg.egg-info/SOURCES.txt +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg.egg-info/dependency_links.txt +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg.egg-info/entry_points.txt +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/src/roagg.egg-info/top_level.txt +0 -0
- {roagg-2025.0.8 → roagg-2025.0.9}/tests/test_utils.py +0 -0
roagg-2025.0.9/PKG-INFO
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: roagg
|
|
3
|
+
Version: 2025.0.9
|
|
4
|
+
Summary: A command line tool to aggregate research output metadata from DataCite, OpenAIRE and OpenAlex based on an organisations ROR ID
|
|
5
|
+
License: MIT License
|
|
6
|
+
|
|
7
|
+
Copyright (c) 2025 Swedish National Data Service
|
|
8
|
+
|
|
9
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
10
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
11
|
+
in the Software without restriction, including without limitation the rights
|
|
12
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
13
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
14
|
+
furnished to do so, subject to the following conditions:
|
|
15
|
+
|
|
16
|
+
The above copyright notice and this permission notice shall be included in all
|
|
17
|
+
copies or substantial portions of the Software.
|
|
18
|
+
|
|
19
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
20
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
21
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
22
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
23
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
24
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
25
|
+
SOFTWARE.
|
|
26
|
+
|
|
27
|
+
Requires-Python: >=3.10
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
License-File: LICENSE
|
|
30
|
+
Dynamic: license-file
|
|
31
|
+
|
|
32
|
+
# Research output aggregator
|
|
33
|
+
> [!NOTE]
|
|
34
|
+
> This script is under development
|
|
35
|
+
|
|
36
|
+
The goal of this project is to create a script to get a summarization for a research organization about the research output.
|
|
37
|
+
First target is to query and process information from DataCite.
|
|
38
|
+
|
|
39
|
+
The goal for this script is to create a list over research output where an organization is mentioned as:
|
|
40
|
+
* publisher
|
|
41
|
+
* creator with affiliation to the organization
|
|
42
|
+
* contributor with affiliation to the organization
|
|
43
|
+
|
|
44
|
+
input: ROR-id and list of variants on the organization name.
|
|
45
|
+
|
|
46
|
+
Properties to collect for each research output:
|
|
47
|
+
|Field |Type |Comment |
|
|
48
|
+
|--------------------------------------|-------|---------------------------------------------------------------------------------------|
|
|
49
|
+
|publicationYear |integer|The year of publication, can be empty in some cases |
|
|
50
|
+
|resourceType |string |The resource type (free text string) |
|
|
51
|
+
|title |string |Title of the resource (first one if multiple) |
|
|
52
|
+
|publisher |string |Publisher (free text) |
|
|
53
|
+
|createdAt |string |Created date if availible |
|
|
54
|
+
|updatedAt |string |Updatade date if availible |
|
|
55
|
+
|isPublisher |bool |True if the the publisher match the requested organisation |
|
|
56
|
+
|isFunder |bool |True if the the funder match the requested organisation |
|
|
57
|
+
|haveCreatorAffiliation |bool |True if the the any creator match the requested organisation |
|
|
58
|
+
|haveContributorAffiliation |bool |True if the the any contributor match the requested organisation |
|
|
59
|
+
|isLatestVersion |bool |True if the DataCite metadata indicates this beeing the latest version |
|
|
60
|
+
|isConceptDoi |bool |True if the DataCite metadata indicates this beeing a concept DOI |
|
|
61
|
+
|matchPublisherRor |bool |True if the ROR id for publisher match the ROR in the provided argument |
|
|
62
|
+
|matchCreatorAffiliationRor |bool |True if the ROR id for a creator affiliation match the ROR in the provided argument |
|
|
63
|
+
|matchContributorAffiliationRor |bool |True if the ROR id for a contributor affiliation match the ROR in the provided argument|
|
|
64
|
+
|matchFunderRor |bool |True if the ROR id for funder match the ROR in the provided argument |
|
|
65
|
+
|matchPublisherName |bool |True if any of the names supplied matches the publisher name in the resource |
|
|
66
|
+
|matchCreatorName |bool |True if any of the names supplied matches the creator name in the resource |
|
|
67
|
+
|matchContributorName |bool |True if any of the names supplied matches the contributor name in the resource |
|
|
68
|
+
|matchFunderName |bool |True if any of the names supplied matches the funder name in the resource |
|
|
69
|
+
|inDataCite |bool |True if the DOI was matched in the DataCite |
|
|
70
|
+
|inOpenAire |bool |True if the DOI was matched in OpenAire |
|
|
71
|
+
|inOpenAlex |bool |True if the DOI was matched in OpenAlex |
|
|
72
|
+
|inCrossRef |bool |True if the DOI was matched in CrossRef |
|
|
73
|
+
|dataCiteClientId |string |The client id for the organisation minting the DOI |
|
|
74
|
+
|dataCiteClientName |string |The human readable name of the minting organisation |
|
|
75
|
+
|dataCiteCitationCount |integer|Citation count for the resource provided by the DataCite API |
|
|
76
|
+
|dataCiteReferenceCount |integer|Reference count for the resource provided by the DataCite API |
|
|
77
|
+
|dataCiteViewCount |integer|View count for the resource provided by the DataCite API |
|
|
78
|
+
|dataCiteDownloadCount |integer|Download count for the resource provided by the DataCite API |
|
|
79
|
+
|openAireBestAccessRight |string |Access Rights for the resource indicated indicated by the OpenAire API |
|
|
80
|
+
|openAireIndicatorsUsageCountsDownloads|integer|Download count for the resource indicated by the OpenAire API |
|
|
81
|
+
|openAireIndicatorsUsageCountsViews |integer|View count for the resource provided by the OpenAire API |
|
|
82
|
+
|openAireId |string |Id for the resource in OpenAire |
|
|
83
|
+
|openAlexId |string |Id for the resource in OpenAlex |
|
|
84
|
+
|openAlexCitedByCount |integer|Citation count for the resource provided by the OpenAlex API |
|
|
85
|
+
|openAlexReferencedWorksCount |integer|Reference count for the resource provided by the OpenAlex API |
|
|
86
|
+
|titleWordCount |integer|Number of words in the title (useful for sorting in some cases) |
|
|
87
|
+
|referencedByDoi |string | |
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
## Install
|
|
91
|
+
`pip install .`
|
|
92
|
+
|
|
93
|
+
## Install dev
|
|
94
|
+
`pip install -e .`
|
|
95
|
+
|
|
96
|
+
## Development stuff to do
|
|
97
|
+
- [x] ROR get name variants from ROR
|
|
98
|
+
- [x] CLI add options to get name list from txt
|
|
99
|
+
- [x] DataCite API build query for matching publisher and affiliation
|
|
100
|
+
- [ ] Crossref API build query for matching publisher and affiliation
|
|
101
|
+
- [ ] Publish as cmd tool on PyPI
|
|
102
|
+
|
|
103
|
+
## Run
|
|
104
|
+
List arguments:
|
|
105
|
+
`roagg --help`
|
|
106
|
+
|
|
107
|
+
## Tests
|
|
108
|
+
Some tests are available, to run them:
|
|
109
|
+
`python -m pytest`
|
|
110
|
+
|
|
111
|
+
### Some example arguments
|
|
112
|
+
Chalmers with ror and name list:
|
|
113
|
+
```bash
|
|
114
|
+
roagg --ror https://ror.org/040wg7k59 --name-txt tests/name-lists/chalmers.txt --output chalmers.csv
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
GU with ror, name list and extra name not in the text file:
|
|
118
|
+
```bash
|
|
119
|
+
roagg --name "Department of Nephrology Gothenburg" --ror https://ror.org/01tm6cn81 --name-txt tests/name-lists/gu.txt --output data/gu.csv
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
KTH with ror and name list:
|
|
123
|
+
```bash
|
|
124
|
+
roagg --ror https://ror.org/026vcq606 --name-txt tests/name-lists/kth.txt --output data/kth.csv
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
KAU with ror:
|
|
128
|
+
```bash
|
|
129
|
+
roagg --ror https://ror.org/05s754026 --output kau.csv
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## License
|
|
133
|
+
[MIT License](LICENSE)
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "roagg"
|
|
3
|
-
|
|
3
|
+
description = "A command line tool to aggregate research output metadata from DataCite, OpenAIRE and OpenAlex based on an organisations ROR ID"
|
|
4
|
+
readme = "README.md"
|
|
5
|
+
license = {file = "LICENSE"}
|
|
6
|
+
version = "2025.0.9"
|
|
4
7
|
requires-python = ">=3.10"
|
|
5
8
|
dependencies = []
|
|
6
9
|
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: roagg
|
|
3
|
+
Version: 2025.0.9
|
|
4
|
+
Summary: A command line tool to aggregate research output metadata from DataCite, OpenAIRE and OpenAlex based on an organisations ROR ID
|
|
5
|
+
License: MIT License
|
|
6
|
+
|
|
7
|
+
Copyright (c) 2025 Swedish National Data Service
|
|
8
|
+
|
|
9
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
10
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
11
|
+
in the Software without restriction, including without limitation the rights
|
|
12
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
13
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
14
|
+
furnished to do so, subject to the following conditions:
|
|
15
|
+
|
|
16
|
+
The above copyright notice and this permission notice shall be included in all
|
|
17
|
+
copies or substantial portions of the Software.
|
|
18
|
+
|
|
19
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
20
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
21
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
22
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
23
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
24
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
25
|
+
SOFTWARE.
|
|
26
|
+
|
|
27
|
+
Requires-Python: >=3.10
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
License-File: LICENSE
|
|
30
|
+
Dynamic: license-file
|
|
31
|
+
|
|
32
|
+
# Research output aggregator
|
|
33
|
+
> [!NOTE]
|
|
34
|
+
> This script is under development
|
|
35
|
+
|
|
36
|
+
The goal of this project is to create a script to get a summarization for a research organization about the research output.
|
|
37
|
+
First target is to query and process information from DataCite.
|
|
38
|
+
|
|
39
|
+
The goal for this script is to create a list over research output where an organization is mentioned as:
|
|
40
|
+
* publisher
|
|
41
|
+
* creator with affiliation to the organization
|
|
42
|
+
* contributor with affiliation to the organization
|
|
43
|
+
|
|
44
|
+
input: ROR-id and list of variants on the organization name.
|
|
45
|
+
|
|
46
|
+
Properties to collect for each research output:
|
|
47
|
+
|Field |Type |Comment |
|
|
48
|
+
|--------------------------------------|-------|---------------------------------------------------------------------------------------|
|
|
49
|
+
|publicationYear |integer|The year of publication, can be empty in some cases |
|
|
50
|
+
|resourceType |string |The resource type (free text string) |
|
|
51
|
+
|title |string |Title of the resource (first one if multiple) |
|
|
52
|
+
|publisher |string |Publisher (free text) |
|
|
53
|
+
|createdAt |string |Created date if availible |
|
|
54
|
+
|updatedAt |string |Updatade date if availible |
|
|
55
|
+
|isPublisher |bool |True if the the publisher match the requested organisation |
|
|
56
|
+
|isFunder |bool |True if the the funder match the requested organisation |
|
|
57
|
+
|haveCreatorAffiliation |bool |True if the the any creator match the requested organisation |
|
|
58
|
+
|haveContributorAffiliation |bool |True if the the any contributor match the requested organisation |
|
|
59
|
+
|isLatestVersion |bool |True if the DataCite metadata indicates this beeing the latest version |
|
|
60
|
+
|isConceptDoi |bool |True if the DataCite metadata indicates this beeing a concept DOI |
|
|
61
|
+
|matchPublisherRor |bool |True if the ROR id for publisher match the ROR in the provided argument |
|
|
62
|
+
|matchCreatorAffiliationRor |bool |True if the ROR id for a creator affiliation match the ROR in the provided argument |
|
|
63
|
+
|matchContributorAffiliationRor |bool |True if the ROR id for a contributor affiliation match the ROR in the provided argument|
|
|
64
|
+
|matchFunderRor |bool |True if the ROR id for funder match the ROR in the provided argument |
|
|
65
|
+
|matchPublisherName |bool |True if any of the names supplied matches the publisher name in the resource |
|
|
66
|
+
|matchCreatorName |bool |True if any of the names supplied matches the creator name in the resource |
|
|
67
|
+
|matchContributorName |bool |True if any of the names supplied matches the contributor name in the resource |
|
|
68
|
+
|matchFunderName |bool |True if any of the names supplied matches the funder name in the resource |
|
|
69
|
+
|inDataCite |bool |True if the DOI was matched in the DataCite |
|
|
70
|
+
|inOpenAire |bool |True if the DOI was matched in OpenAire |
|
|
71
|
+
|inOpenAlex |bool |True if the DOI was matched in OpenAlex |
|
|
72
|
+
|inCrossRef |bool |True if the DOI was matched in CrossRef |
|
|
73
|
+
|dataCiteClientId |string |The client id for the organisation minting the DOI |
|
|
74
|
+
|dataCiteClientName |string |The human readable name of the minting organisation |
|
|
75
|
+
|dataCiteCitationCount |integer|Citation count for the resource provided by the DataCite API |
|
|
76
|
+
|dataCiteReferenceCount |integer|Reference count for the resource provided by the DataCite API |
|
|
77
|
+
|dataCiteViewCount |integer|View count for the resource provided by the DataCite API |
|
|
78
|
+
|dataCiteDownloadCount |integer|Download count for the resource provided by the DataCite API |
|
|
79
|
+
|openAireBestAccessRight |string |Access Rights for the resource indicated indicated by the OpenAire API |
|
|
80
|
+
|openAireIndicatorsUsageCountsDownloads|integer|Download count for the resource indicated by the OpenAire API |
|
|
81
|
+
|openAireIndicatorsUsageCountsViews |integer|View count for the resource provided by the OpenAire API |
|
|
82
|
+
|openAireId |string |Id for the resource in OpenAire |
|
|
83
|
+
|openAlexId |string |Id for the resource in OpenAlex |
|
|
84
|
+
|openAlexCitedByCount |integer|Citation count for the resource provided by the OpenAlex API |
|
|
85
|
+
|openAlexReferencedWorksCount |integer|Reference count for the resource provided by the OpenAlex API |
|
|
86
|
+
|titleWordCount |integer|Number of words in the title (useful for sorting in some cases) |
|
|
87
|
+
|referencedByDoi |string | |
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
## Install
|
|
91
|
+
`pip install .`
|
|
92
|
+
|
|
93
|
+
## Install dev
|
|
94
|
+
`pip install -e .`
|
|
95
|
+
|
|
96
|
+
## Development stuff to do
|
|
97
|
+
- [x] ROR get name variants from ROR
|
|
98
|
+
- [x] CLI add options to get name list from txt
|
|
99
|
+
- [x] DataCite API build query for matching publisher and affiliation
|
|
100
|
+
- [ ] Crossref API build query for matching publisher and affiliation
|
|
101
|
+
- [ ] Publish as cmd tool on PyPI
|
|
102
|
+
|
|
103
|
+
## Run
|
|
104
|
+
List arguments:
|
|
105
|
+
`roagg --help`
|
|
106
|
+
|
|
107
|
+
## Tests
|
|
108
|
+
Some tests are available, to run them:
|
|
109
|
+
`python -m pytest`
|
|
110
|
+
|
|
111
|
+
### Some example arguments
|
|
112
|
+
Chalmers with ror and name list:
|
|
113
|
+
```bash
|
|
114
|
+
roagg --ror https://ror.org/040wg7k59 --name-txt tests/name-lists/chalmers.txt --output chalmers.csv
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
GU with ror, name list and extra name not in the text file:
|
|
118
|
+
```bash
|
|
119
|
+
roagg --name "Department of Nephrology Gothenburg" --ror https://ror.org/01tm6cn81 --name-txt tests/name-lists/gu.txt --output data/gu.csv
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
KTH with ror and name list:
|
|
123
|
+
```bash
|
|
124
|
+
roagg --ror https://ror.org/026vcq606 --name-txt tests/name-lists/kth.txt --output data/kth.csv
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
KAU with ror:
|
|
128
|
+
```bash
|
|
129
|
+
roagg --ror https://ror.org/05s754026 --output kau.csv
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## License
|
|
133
|
+
[MIT License](LICENSE)
|
roagg-2025.0.8/PKG-INFO
DELETED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|