Skip to content

Commit f53577f

Browse files
committed
Update README.md
1 parent 928db0c commit f53577f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# ORCIDWorks
2-
> Collect works metadata from ORCID.org
32

4-
<span style="display:block;text-align:right"><img src="https://orcidhub.org.nz/static/images/logo.png" width="48" height="48" alt="ORCID Hub logo"></span>
3+
<img src="https://orcidhub.org.nz/static/images/logo.png" align="right" width="48" height="48" alt="ORCID Hub logo">
4+
5+
> Collect works metadata from ORCID.org
56
67
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).
78

@@ -15,7 +16,7 @@ You'll need Python 3.6+ (and [pip](https://pip.pypa.io/en/stable/)).
1516

1617
You'll need to obtain credentials from both the [ORCID.org API](https://info.orcid.org/documentation/features/public-api/) and the [NZ ORCID Hub API](https://orcidhub.org.nz/api-docs). For the latter, choose "Hub API Registration" from the "Settings" menu.
1718

18-
> **_NB:_** We suggest using [the ORCID.org sandbox](https://sandbox.orcid.org/signin) and [Test Hub](https://test.orcidhub.org.nz) first. (See [#Configuration](#configuration) below.)
19+
> We suggest using [the ORCID.org sandbox](https://sandbox.orcid.org/signin) and [Test Hub](https://test.orcidhub.org.nz) first. (See "Configuration" below.)
1920
2021
## Running
2122

@@ -26,13 +27,14 @@ pip install -r requirements.txt
2627
```
2728

2829
### Secrets
29-
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`, so it won't be committed.)
3030

31+
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`, so it won't be committed.)
3132

3233
### Run
3334

3435
You should now be able to run the script. In VSCode, press <kbd>F5</kbd>.
35-
## [Configuration](#Configuration)
36+
37+
## Configuration
3638

3739
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).
3840

@@ -42,4 +44,4 @@ The script uses [python-decouple](https://pypi.org/project/python-decouple/) to
4244

4345
## Licensing
4446

45-
[MIT](/LICENSE).
47+
[MIT](/LICENSE).

0 commit comments

Comments
 (0)