Metadata-Version: 2.1
Name: deepsearch-toolkit
Version: 0.28.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.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Typing :: Typed
Provides-Extra: all
Provides-Extra: api
Requires-Dist: anyio (>=3.6.2,<4.0.0) ; extra == "api" or extra == "all"
Requires-Dist: certifi (>=2023.07.22,<2024.0.0)
Requires-Dist: fastapi (>=0.103.0,<0.104.0) ; extra == "api" or extra == "all"
Requires-Dist: platformdirs (>=3.5.1,<4.0.0)
Requires-Dist: pluggy (>=1.0.0,<2.0.0)
Requires-Dist: pydantic[dotenv] (>=1.10.8,<2.0.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.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: typer[all] (>=0.9.0,<0.10.0)
Requires-Dist: urllib3 (>=1.26.8,<2.0.0)
Requires-Dist: uvicorn (>=0.21.1,<0.22.0) ; extra == "api" or extra == "all"
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

# Deep Search 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/)
[![Downloads](https://static.pepy.tech/badge/deepsearch-toolkit)](https://pepy.tech/project/deepsearch-toolkit)


*Interact with the Deep Search platform for new knowledge explorations and discoveries*


The Deep Search Toolkit is a Python SDK and CLI allowing users 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

- [Documentation](https://ds4sd.github.io/deepsearch-toolkit)
- [Deep Search Examples](https://github.com/ds4sd/deepsearch-examples)


## Install

To set up, just install `deepsearch-toolkit` with your packaging tool.

With [`poetry`](https://python-poetry.org):
```console
poetry add deepsearch-toolkit
```

With `pip`:
```console
pip install deepsearch-toolkit
```

### Extras
Optional functionality can be installed as package "extras". To install all extras, use
`deepsearch-toolkit[all]` with your packaging tool.

### Install as toolkit developer
If you are a Deep Search Toolkit developer, set up as follows:
```console
poetry install --all-extras
```

### Requirements

Python 3.8+

## Start using the toolkit

### Set up a profile
For details, check [Profiles](https://ds4sd.github.io/deepsearch-toolkit/guide/configuration#profiles).
```console
deepsearch profile config
```

### Convert a document
For details, check [Document conversion](https://ds4sd.github.io/deepsearch-toolkit/guide/convert_doc).
```console
deepsearch documents convert -p 1234567890abcdefghijklmnopqrstvwyz123456 -u https://arxiv.org/pdf/2206.00785.pdf
```

The output should look like:
```
Submitting input:     : 100%|██████████████████████████████| 1/1 [00:01<00:00,  1.52s/it]
Converting input:     : 100%|██████████████████████████████| 1/1 [00:33<00:00, 33.80s/it]
Downloading result:   : 100%|██████████████████████████████| 1/1 [00:01<00:00,  1.11s/it]
Total online documents             1
Successfully converted documents   1
```


## 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 Deep Search Toolkit](./CONTRIBUTING.md) for details.


## References

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

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

## License

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

