Metadata-Version: 2.1
Name: deepsearch-toolkit
Version: 0.1.0
Summary: Interact with the Deep Search platform for new knowledge explorations and discoveries
Home-page: https://ds4sd.github.io/deepsearch-toolkit/
License: MIT
Keywords: deepsearch,convert,knowledge graph,discovery,nlp
Author: Michele Dolfi
Author-email: dol@zurich.ibm.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Typing :: Typed
Provides-Extra: examples
Requires-Dist: appdirs (>=1.4.4,<2.0.0)
Requires-Dist: certifi (>=2021.10.8,<2022.0.0)
Requires-Dist: ipython-blocking (>=0.3.1,<0.4.0); extra == "examples"
Requires-Dist: ipywidgets (>=7.6.5,<8.0.0); extra == "examples"
Requires-Dist: jupyter (>=1.0.0,<2.0.0); extra == "examples"
Requires-Dist: numpy (>=1.22.4,<2.0.0); extra == "examples"
Requires-Dist: pandas (>=1.4.2,<2.0.0); extra == "examples"
Requires-Dist: pluggy (>=1.0.0,<2.0.0)
Requires-Dist: pydantic (>=1.9.0,<2.0.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: python-jose (>=3.3.0,<4.0.0)
Requires-Dist: requests (>=2.27.1,<3.0.0)
Requires-Dist: six (>=1.16.0,<2.0.0)
Requires-Dist: tabulate (>=0.8.9,<0.9.0)
Requires-Dist: tqdm (>=4.64.0,<5.0.0)
Requires-Dist: tqdm-stubs (>=0.2.0,<0.3.0)
Requires-Dist: typer (>=0.4.0,<0.5.0)
Requires-Dist: urllib3 (>=1.26.8,<2.0.0)
Project-URL: Bug Tracker, https://github.com/DS4SD/deepsearch-toolkit/issues
Project-URL: Documentation, https://ds4sd.github.io/deepsearch-toolkit/
Project-URL: Discussion forum, https://github.com/DS4SD/deepsearch-toolkit/discussions
Project-URL: Repository, https://github.com/DS4SD/deepsearch-toolkit
Description-Content-Type: text/markdown

# DeepSearch Toolkit

[![PyPI version](https://img.shields.io/pypi/v/deepsearch-toolkit)](https://pypi.org/project/deepsearch-toolkit/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/deepsearch-toolkit)](https://pypi.org/project/deepsearch-toolkit/)
[![License MIT](https://img.shields.io/github/license/ds4sd/deepsearch-toolkit)](https://opensource.org/licenses/MIT)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Docs](https://img.shields.io/badge/website-live-brightgreen)](https://ds4sd.github.io/deepsearch-toolkit/)


*Interact with the DeepSearch platform for new knowledge explorations and discoveries*


The Deep Search Toolkit is a Python SDK allowing a user to interact with the Deep Search platform. The Toolkit provides easy-to-use functionalities for several common processes such as document conversion, graph creation and querying.


[Learn about IBM Deep Search](https://ds4sd.github.io/)


## Quick links

- [Github repository](https://github.com/ds4sd/deepsearch-toolkit)
- [Documentation](https://ds4sd.github.io/deepsearch-toolkit/)


## Install

Using `poetry` in your project? Add the toolkit with:
```console
$ poetry add deepsearch-toolkit
```

New to `poetry`? Visit https://python-poetry.org/ or our [CONTRIBUTING.md](CONTRIBUTING.md) section.


Using `pip`:
```console
$ pip install deepsearch-toolkit
```

### Requirements

Python 3.8+


## Get help and support

Please feel free to connect with us using the [discussion section](https://github.com/DS4SD/deepsearch-toolkit/discussions).


## Contributing

Please read [Contributing to DeepSearch Toolkit](./CONTRIBUTING.md) for details.


## References

If you use `DeepSearch` in your projects, please consider citing the following:

```bib
@software{DeepSearch Toolkit,
author = {DeepSearch Team},
month = {6},
title = {{DeepSearch Toolkit}},
url = {https://github.com/DS4SD/deepsearch-toolkit},
version = {main},
year = {2022}
}
```

## License

The `DeepSearch Toolkit` codebase is under MIT license.
For individual model usage, please refer to the model licenses found in the original packages.

