About

A simple wrapper around the orcid.org API. Ready to run examples can be found in the examples folder.

Installation

Using pip

Install latest relased version

pip install -i https://test.pypi.org/simple/ orcidpyclient --upgrade

Install latest version from source code

pip install git+https://github.com/vdmitriyev/orcidpyclient.git

Manual

• Download from the GitHub latest version
• Unzip archive
• Create virtualenv (scripts/cmdInitiateEnv.bat)
• Activate virtualenv (scripts/cmdStartEnv.bat)
• Run examples

Documentation

Documentation is available here

Examples

Ready to Run Examples

• Ready to run examples can be found in the folder docs -> examples

Development

Getting started

• Create virtualenv using scripts/cmdInitiateEnv.bat and activate it
• Star VS Code

  code .

Run tests

• Run tests -> pytest

  cd tests
  pytest

• Run tests -> tox

  tox
  tox -e py310

Build documentation

• Build manually

  sphinx-build docs docs/_build

• Build with autobuild

  sphinx-autobuild docs docs/_build/html

License

MIT

Credits

• Created based on the cloned repository https://github.com/scholrly/orcid-python lead by Matt Luongo