Metadata-Version: 2.1
Name: summ
Version: 0.1.1
Summary: Summ provides intelligent question-answering and search capabilities across user interview transcripts.
Project-URL: Documentation, https://github.com/yasyf/summ#readme
Project-URL: Issues, https://github.com/yasyf/summ/issues
Project-URL: Source, https://github.com/yasyf/summ
Author-email: Yasyf Mohamedali <yasyfm+pypi@gmail.com>, Markie Wagner <me@markiewagner.com>
License-Expression: AGPL-3.0-only
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: click
Requires-Dist: jinja2
Requires-Dist: joblib
Requires-Dist: langchain
Requires-Dist: metrohash
Requires-Dist: openai
Requires-Dist: pinecone-client
Requires-Dist: redis-om
Requires-Dist: redis[hiredis]
Requires-Dist: retry
Requires-Dist: termcolor
Requires-Dist: tiktoken
Description-Content-Type: text/markdown

# Summ

[![PyPI - Version](https://img.shields.io/pypi/v/summ.svg)](https://pypi.org/project/summ)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/summ.svg)](https://pypi.org/project/summ)

-----

Summ uses ChatGPT to provide intelligent question-answering and search capabilities across user transcripts!

Easily surface insights and summarize facts across various dimensions such as department, industry, and role. With the help of natural language processing, the tool can understand and respond to complex questions and queries, making it easy for users to find the information they need.

A tool by [@markiewagner](https://github.com/markiewagner) and [@yasyf](https://github.com/yasyf).

[![asciicast](https://asciinema.org/a/Ys2rH36AlF7RIdzZbJiorhMcc.svg)](https://asciinema.org/a/Ys2rH36AlF7RIdzZbJiorhMcc)

## Installation

```console
pip install summ
```

You'll need an instance of [Redis Stack](https://redis.io/docs/stack/get-started/install/) running. We've found that `brew install redis-stack/redis-stack/redis-stack` is the fastest way to get up and running.

You'll also need to set two environment variables: `OPENAI_API_KEY`, and `PINECONE_API_KEY`

## Quickstart

You don't need to do any configuration to start using `summ`. Simply use `summ.Pipeline.default` and pass a path to a directory with text files.

However, the tool works much better when users are tagged. In order to do so, you need to specify two things:

1. The categories of tags (and the tags within each category).
2. A prompt directing how to apply the tags of a given category.

You can see an example of this at [`examples/otter`](examples/otter).

## Docs

Check out the [`examples`](examples) directory for some samples, or dive into the full docs at [summ.readthedocs.io](https://summ.readthedocs.io/en/latest/).

## License

`summ` is distributed under the terms of the [AGPL 3.0](https://spdx.org/licenses/AGPL-3.0-only.html) license.
