Metadata-Version: 2.4
Name: orcidpyclient
Version: 2.1
Summary: A simple wrapper around the ORCID.org API
Home-page: https://github.com/vdmitriyev/orcidpyclient
Author: vdmitriyev
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28.0
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

## 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 related version
```
pip install --upgrade orcidpyclient
```

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/refs/heads/main.zip) latest version as archive
* 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)
