Skip to content

Commit 37e9118

Browse files
committed
explain how to use getORCIDToken.py
1 parent 4a862b1 commit 37e9118

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
> Collect works metadata from ORCID.org
66
7-
Adapted from [a gist](https://gist.github.com/Jason-Gush/bcbab1c3c55e5684251ad3b8ee04eded) by [@JasonGush](https://github.com/Jason-Gush), this is a Python script that collects works on ORCID from their API from a list of users affiliated with an institution on the [NZ ORCID Hub](https://orcidhub.org.nz).
7+
Adapted from [a gist](https://gist.github.com/Jason-Gush/bcbab1c3c55e5684251ad3b8ee04eded) by [@JasonGush](https://github.com/Jason-Gush), this is a Python script that collects works on ORCID from their API from a list of users affiliated with an institution on the [NZ ORCID Hub](https://orcidhub.org.nz) and outputs them to a CSV file.
88

99
## Installation
1010

@@ -30,13 +30,17 @@ pip install -r requirements.txt
3030

3131
Rename [`.env.sample`](.env.sample) to `.env`, and copy and paste your access keys and secrets into it at the appropriate lines. (`.env` is included in [`.gitignore`](https://git-scm.com/docs/gitignore), so it won't be committed.)
3232

33+
### Get token
34+
35+
Run [getORCIDToken.py](getORCIDToken.py) to acquire a token. This will log to [getORCIDToken.log](getORCIDtoken.log).
36+
3337
### Run
3438

35-
You should now be able to run the script. (In VSCode, press <kbd>F5</kbd>.)
39+
You should now be able to run the main script, `getworks.py`. (In VSCode, press <kbd>F5</kbd>.)
3640

3741
## Configuration
3842

39-
Set `testing` to `True` in [ORCIDWorks.py](ORCIDWorks.py) to use the [ORCID.org sandbox](https://sandbox.orcid.org) and [test.orcidhub.org.nz](https://test.orcidhub.org.nz).
43+
Set `testing` to `True` in [getworks.py](https://github.com/AMCollectionsData/ORCIDWorks/blob/4a862b19f71dc44929c532e0acd6f5f4cf535f2c/getworks.py#L20) to have the script use the [ORCID.org sandbox](https://sandbox.orcid.org) and [test.orcidhub.org.nz](https://test.orcidhub.org.nz).
4044

4145
## Libraries
4246

@@ -48,4 +52,4 @@ Issued under the [MIT](/LICENSE) license.
4852

4953
## Help
5054

51-
Please use [Discussions](discussions) to ask for help, or [raise an issue](issues) to report a bug or request a new feature.
55+
Please use [Discussions](//github.com/AMCollectionsData/ORCIDWorks/discussions) to ask for help, or [raise an issue](//github.com/AMCollectionsData/ORCIDWorks/issues/new/choose) to report a bug or request a new feature.

0 commit comments

Comments
 (0)