Metadata-Version: 2.1
Name: textgraphs
Version: 0.3.1
Summary: TextGraphs + LLMs + graph ML for entity extraction, linking, ranking, and constructing a lemma graph
Author-email: "derwen.ai" <info@derwen.ai>
License: MIT License
        
        Copyright (c) 2023-2024 Derwen, Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: home, https://huggingface.co/spaces/DerwenAI/textgraphs
Project-URL: docs, https://derwen.ai/docs/txg/
Project-URL: code, https://github.com/DerwenAI/textgraphs
Project-URL: PyPi, https://pypi.org/project/textgraphs/
Project-URL: DOI, https://zenodo.org/doi/10.5281/zenodo.10431783
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: beautifulsoup4>=4.12
Requires-Dist: GitPython>=3.1
Requires-Dist: icecream>=2.1
Requires-Dist: markdown2>=2.4
Requires-Dist: matplotlib>=3.8
Requires-Dist: networkx>=3.2
Requires-Dist: pulp>=2.7
Requires-Dist: pyvis>=0.3
Requires-Dist: qwikidata>=0.4
Requires-Dist: spacy>=3.7
Requires-Dist: spacy-dbpedia-spotlight>=0.2.6
Requires-Dist: span_marker>=1.5
Requires-Dist: transformers>=4.35
Requires-Dist: wordcloud>=1.9
Provides-Extra: dev
Requires-Dist: build>=1.0; extra == "dev"
Requires-Dist: Flask>=3.0; extra == "dev"
Requires-Dist: mkdocs-git-revision-date-plugin>=0.3; extra == "dev"
Requires-Dist: mkdocs-material>=9.5; extra == "dev"
Requires-Dist: mknotebooks>=0.8; extra == "dev"
Requires-Dist: pre-commit>=3.5; extra == "dev"
Requires-Dist: selenium>=4.16; extra == "dev"
Requires-Dist: twine>=4.0; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=7.4; extra == "test"
Provides-Extra: demo
Requires-Dist: ipywidgets>=8.1; extra == "demo"
Requires-Dist: jupyterlab_execute_time>=3.1; extra == "demo"
Requires-Dist: jupyterlab>=4.0; extra == "demo"
Requires-Dist: pyinstrument>=4.6; extra == "demo"
Requires-Dist: sense2vec>=2.0; extra == "demo"
Requires-Dist: spacy-entity-linker>=1.0; extra == "demo"
Requires-Dist: streamlit<1.29; extra == "demo"
Requires-Dist: watermark>=2.4; extra == "demo"

---
title: TextGraphs
emoji: ✴
colorFrom: green
colorTo: gray
sdk: streamlit
sdk_version: 1.28.2
app_file: app.py
pinned: false
license: mit
---

# TextGraphs

[![DOI](https://zenodo.org/badge/735568863.svg)](https://zenodo.org/doi/10.5281/zenodo.10431783)
![Licence](https://img.shields.io/github/license/DerwenAI/textgraphs)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
![CI](https://github.com/DerwenAI/textgraphs/workflows/CI/badge.svg)
<br/>
![Repo size](https://img.shields.io/github/repo-size/DerwenAI/textgraphs)
![downloads](https://img.shields.io/pypi/dm/textgraphs)
![sponsor](https://img.shields.io/github/sponsors/ceteri)

<img
 alt="TextGraphs logo"
 src="https://raw.githubusercontent.com/DerwenAI/textgraphs/main/docs/assets/logo.png"
 width="231"
/>


## project info

Project home: <https://huggingface.co/spaces/DerwenAI/textgraphs>

Full documentation: <https://derwen.ai/docs/txg/>

Sample code is provided in `demo.py`


## requirements

  * Python 3.10+


## deploy library from PyPi

To install from [PyPi](https://pypi.python.org/pypi/textgraphs):

```bash
python3 -m pip install -u textgraphs
python3 -m pip install git+https://github.com/thunlp/OpenNRE
```

NB: both the spaCy and PyPi teams induce packaging errors
since they have "opinionated" views which conflict against
each other and also don't quite follow the Python packaging
standards.


## run demos locally

```bash
python3 demo.py
```

```bash
./venv/bin/jupyter-lab
```

```bash
streamlit run app.py
```


## install library from a source code repo locally

```bash
python3 -m venv venv
source venv/bin/activate

python3 -m pip install -U pip wheel setuptools
python3 -m pip install -r requirements.txt
python3 -m pip install git+https://github.com/thunlp/OpenNRE
```

to run the Streamlit or JupyterLab demos, also install:

```bash
python3 -m pip install -r requirements-dev.txt
```


## license and copyright

Source code for **TextGraphs** plus its logo, documentation, and
examples have an [MIT license](https://spdx.org/licenses/MIT.html)
which is succinct and simplifies use in commercial applications.

All materials herein are Copyright &copy; 2023-2024 Derwen, Inc.


## attribution

Please use the following BibTeX entry for citing **TextGraphs** if you
use it in your research or software:
```bibtex
@software{TextGraphs,
  author = {Paco Nathan},
  title = {{TextGraphs + LLMs + graph ML for entity extraction, linking, ranking, and constructing a lemma graph}},
  year = 2023,
  publisher = {Derwen},
  doi = {10.5281/zenodo.10431783},
  url = {https://github.com/DerwenAI/textgraphs}
}
```


## star history

[![Star History Chart](https://api.star-history.com/svg?repos=derwenai/textgraphs&type=Date)](https://star-history.com/#derwenai/textgraphs&Date)
