Metadata-Version: 2.1
Name: kgforge
Version: 0.2.11
Summary: Library to automate extraction of scientific knowledge and generate knowledge graphs out of them.
License: MIT
Author: Harish Varma Siravuri
Author-email: harish.siravuri@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: matplotlib (>=3.8.0,<4.0.0)
Requires-Dist: pdfminer (>=20191125,<20191126)
Requires-Dist: pydantic (>=2.4.2,<3.0.0)
Requires-Dist: pypdf2 (>=3.0.1,<4.0.0)
Requires-Dist: pytest (>=7.4.2,<8.0.0)
Requires-Dist: torch (>=2.0.0,!=2.0.1,!=2.1.0)
Requires-Dist: transformers (>=4.34.0,<5.0.0)
Description-Content-Type: text/markdown

<h1 align="center">
  <br>
  <img src="https://github.com/harishsiravuri/kgforge/blob/main/images/kgforge_logo.svg?raw=true"  width="400" height="400" alt="kgforge logo"/>
  <br>
</h1>

<h2 align="center">Library to extract Knowledge Graphs from scholarly text</h2>

<h1 align="center"><a href="https://harishsiravuri.github.io/kgforge/">kgforge Documentation</h1>

<p align="center">

   <a alt="Tests" href="https://github.com/harishsiravuri/kgforge/actions/workflows/publish-to-pypi.yml/badge.svg">
      <img src="https://github.com/harishsiravuri/kgforge/actions/workflows/publish-to-pypi.yml/badge.svg?branch=main">
  </a>
  <img alt="Code Style" src="https://img.shields.io/badge/  code%20style-black-000000.svg" />
  <a href="https://www.python.org/downloads/release/python-390/">
  </a>
  <a href="https://pypi.org/project/kgforge" target="_blank">
    <img src="https://img.shields.io/badge/python-3.11-blue.svg" alt="Supported Python versions">
  </a>
  <a href="https://img.shields.io/pypi/dw/kgforge" target="_blank">
    <img src="https://img.shields.io/pypi/dw/kgforge" alt="Downloads per week">
  </a>
  <a href="https://img.shields.io/badge/License-MIT-yellow.svg" target="_blank">
    <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
  </a>
  <a href="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" target="_blank">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="Contribute">
  </a>
  <a href="https://pepy.tech/project/kgforge" target="_blank">
    <img src="https://static.pepy.tech/badge/kgforge" alt="Total Downloads">
  </a>

</p>

<p align="center">
  <a href="#what-is-it">What is it?</a> •
  <a href="#features">Features</a> •
  <a href="#installation">Installation</a> •
  <a href="#usage">Usage</a>  •
  <a href="#contributing">Contributing</a>
</p>

## What is it?
`kgforge` is a library which automates the generation of knowledge graphs from scholarly text.

## Features:
  - **TODO**: TODO: Description.

## Installation:

### Poetry

```bash
poetry add kgforge
```

### Pip

```bash
pip install kgforge
```

Setup your local environment:

Any necessary environment variables description:


```shell
export SAMPLE_ENV_VARIABLE=${VALUE}
```

## Usage

Now that `kgforge` is installed, you're ready to start using it!

It's time to point you to the official [Documentation Website](https://harishsiravuri.github.io/kgforge/) for more information on how to use `kgforge`


## Contributing
If you'd like to contribute, be sure to check out our [contributing guide](./CONTRIBUTING.md)! If you'd like to work on any outstanding items, check out the `roadmap` section in the docs and get started :smiley:

Thanks goes to these incredible people.

<a href="https://github.com/harishsiravuri/kgforge/graphs/contributors">
  <img style="border-radius: 50%" src="https://contrib.rocks/image?repo=harishsiravuri/kgforge" />
</a>

