Get ORCID in bulk and free it from XML
MIT License
Download and process ORCID in bulk
import orcid_downloader
# Takes 10-15 minutes to download
path = orcid_downloader.ensure_summaries()
# Takes a bit more than an hour to parse after downloading was done
records = orcid_downloader.get_records()
The processed records are distributed on .
Grounding can be done on the name field, aliases, and credit name field:
>>> orcid_downloader.ground_researcher("Charles Hoyt")
[ScoredMatch(Term(charles hoyt,Charles Hoyt,orcid,0000-0003-4423-4370,Charles Tapley Hoyt,synonym,orcid,None,None,None),0.5555555555555556,Match(query=Charles Hoyt,ref=Charles Hoyt,exact=True,space_mismatch=False,dash_mismatches={},cap_combos=[]))]
Note It takes about 5 minutes to warm up the grounder, if the data has already been downloaded and processed.
The most recent release can be installed from PyPI with:
pip install orcid_downloader
The most recent code and data can be installed directly from GitHub with:
pip install git+https://github.com/cthoyt/orcid_downloader.git
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.
The code in this package is licensed under the MIT License.
This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-snekpack template.
The final section of the README is for if you want to get involved by making a code contribution.
To install in development mode, use the following:
git clone git+https://github.com/cthoyt/orcid_downloader.git
cd orcid_downloader
pip install -e .
This project uses cruft
to keep boilerplate (i.e., configuration, contribution guidelines, documentation
configuration)
up-to-date with the upstream cookiecutter package. Update with the following:
pip install cruft
cruft update
More info on Cruft's update command is available here.
After cloning the repository and installing tox
with pip install tox tox-uv
,
the unit tests in the tests/
folder can be run reproducibly with:
tox -e py
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
The documentation can be built locally using the following:
git clone git+https://github.com/cthoyt/orcid_downloader.git
cd orcid_downloader
tox -e docs
open docs/build/html/index.html
The documentation automatically installs the package as well as the docs
extra specified in the pyproject.toml
. sphinx
plugins
like texext
can be added there. Additionally, they need to be added to the
extensions
list in docs/source/conf.py
.
The documentation can be deployed to ReadTheDocs using
this guide.
The .readthedocs.yml
YAML file contains all the configuration you'll need.
You can also set up continuous integration on GitHub to check not only that
Sphinx can build the documentation in an isolated environment (i.e., with tox -e docs-test
)
but also that ReadTheDocs can build it too.
Zenodo is a long-term archival system that assigns a DOI to each release of your package.
After these steps, you're ready to go! After you make "release" on GitHub (steps for this are below), you can navigate to https://zenodo.org/account/settings/github/repository/cthoyt/orcid_downloader to see the DOI for the release and link to the Zenodo record for it.
You only have to do the following steps once.
You have to do the following steps once per machine. Create a file in your home directory called
.pypirc
and include the following:
[distutils]
index-servers =
pypi
testpypi
[pypi]
username = __token__
password = <the API token you just got>
# This block is optional in case you want to be able to make test releases to the Test PyPI server
[testpypi]
repository = https://test.pypi.org/legacy/
username = __token__
password = <an API token from test PyPI>
Note that since PyPI is requiring token-based authentication, we use __token__
as the user, verbatim.
If you already have a .pypirc
file with a [distutils]
section, just make sure that there is an index-servers
key and that pypi
is in its associated list. More information on configuring the .pypirc
file can
be found here.
After installing the package in development mode and installing
tox
with pip install tox tox-uv
,
run the following from the shell:
tox -e finish
This script does the following:
pyproject.toml
, CITATION.cff
, src/orcid_downloader/version.py
,docs/source/conf.py
to not have the -dev
suffixuv build
twine
.tox -e bumpversion -- minor
after.This will trigger Zenodo to assign a DOI to your release as well.