https://github.com/vdmitriyev/orcidpyclient
A wrapper client around API of orcid.org
https://github.com/vdmitriyev/orcidpyclient
client orcid orcid-api orcid-wrapper python
Last synced: 5 months ago
JSON representation
A wrapper client around API of orcid.org
- Host: GitHub
- URL: https://github.com/vdmitriyev/orcidpyclient
- Owner: vdmitriyev
- License: other
- Created: 2015-02-12T19:17:51.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T11:25:23.000Z (almost 2 years ago)
- Last Synced: 2026-01-15T07:08:12.034Z (5 months ago)
- Topics: client, orcid, orcid-api, orcid-wrapper, python
- Language: Python
- Homepage:
- Size: 2.74 MB
- Stars: 6
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 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](https://github.com/vdmitriyev/orcidpyclient/archive/master.zip) latest version
* Unzip archive
* Create *virtualenv* (```scripts/cmdInitiateEnv.bat```)
* Activate *virtualenv* (```scripts/cmdStartEnv.bat```)
* Run examples
## Documentation
Documentation is available [here](https://vdmitriyev.github.io/orcidpyclient/)
## 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](https://github.com/mhluongo)