Metadata-Version: 2.1
Name: orkg
Version: 0.17.0
Summary: The official python client for the Open Research Knowledge Graph (ORKG) API
Home-page: http://orkg.org/about
License: MIT
Keywords: ORKG,Scholarly Communication,Digital Library,API Wrapper,Python Client
Author: Yaser Jaradeh
Author-email: yaser.jaradeh@tib.eu
Maintainer: Yaser Jaradeh
Requires-Python: >=3.8
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Build Tools
Requires-Dist: Deprecated (>=1.2.14,<2.0.0)
Requires-Dist: Faker (>=19.1.0,<20.0.0)
Requires-Dist: Inflector (>=3.1.0,<4.0.0)
Requires-Dist: cardinality (>=0.1.1,<0.2.0)
Requires-Dist: hammock (>=0.2.4,<0.3.0)
Requires-Dist: networkx (>=3.1,<4.0)
Requires-Dist: pandas (>=2.0.1,<3.0.0)
Requires-Dist: pydantic (>=2.0.3,<3.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: tqdm (>=4.65.0,<5.0.0)
Requires-Dist: undecorated (>=0.3.0,<0.4.0)
Project-URL: Documentation, https://orkg.readthedocs.io/en/latest/
Project-URL: Repository, https://gitlab.com/TIBHannover/orkg/orkg-pypi
Description-Content-Type: text/markdown

# orkg-pypi
[![pipeline status](https://gitlab.com/TIBHannover/orkg/orkg-pypi/badges/main/pipeline.svg)](https://gitlab.com/TIBHannover/orkg/orkg-pypi/-/commits/master)
[![Documentation Status](https://readthedocs.org/projects/orkg/badge/?version=latest)](https://orkg.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/orkg.svg)](https://badge.fury.io/py/orkg)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![flake8](https://img.shields.io/badge/flake8-enabled-brightgreen)](https://github.com/PyCQA/flake8)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

A python client interacting with the ORKG API and sprinkling some python magic on top.

The package a implements many of the API calls described in the [documentation](http://tibhannover.gitlab.io/orkg/orkg-backend/api-doc/), and provides a set of extra features like graph pythonic objects and dynamic instantiation of entities from specifications.

You can find details about how-to use the package on [Read the Docs](https://orkg.readthedocs.io/en/latest/index.html).

Developers, please note that you need to install the pre-commit script via
```bash
pip install -r requirements.txt
pre-commit install
```
And check the [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

# Noteworthy Contributors

Special thanks to the following awesome people
- Allard Oelen
- Kheir Eddine Farfar
- Omar Arab Oghli
- Julia Evans

