Metadata-Version: 2.4
Name: findprob
Version: 0.2
Summary: A CLI that lets you classify and search for problems by topic using an LLM
Project-URL: Homepage, https://phrdang.github.io/findprob/
Project-URL: Repository, https://github.com/phrdang/findprob.git
Project-URL: Issues, https://github.com/phrdang/findprob/issues
Author-email: Rebecca Dang <rdang@berkeley.edu>, Jessica Lin <linjessica@berkeley.edu>, Samantha Huang <samanthahuang@berkeley.edu>
Maintainer-email: Rebecca Dang <rdang@berkeley.edu>, Jessica Lin <linjessica@berkeley.edu>, Samantha Huang <samanthahuang@berkeley.edu>
License-File: LICENSE
Keywords: AI,LLM,classify problems,edtech,education,find problems,findprob,problems,search problems
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Requires-Dist: beautifulsoup4
Requires-Dist: faiss-cpu
Requires-Dist: langchain
Requires-Dist: langchain-community
Requires-Dist: langchain-core
Requires-Dist: langchain-openai
Requires-Dist: lxml
Requires-Dist: pypdf
Requires-Dist: typer>=0.12.3
Description-Content-Type: text/markdown

# findprob

A CLI to classify and search for problems using LLMs

## Installation

1. Install the package: `pip install findprob`
2. (Optional) Install autocompletion: `findprob --install-completion`
3. Create an [OpenAI](https://platform.openai.com/signup) account and generate a new API key.
4. Create a [LangChain](https://smith.langchain.com/) account and generate a new API key and project.
5. Export the environment variables in your terminal:
```sh
LANGCHAIN_TRACING_V2=true
LANGCHAIN_ENDPOINT="https://api.smith.langchain.com"
LANGCHAIN_API_KEY=<YOUR API KEY HERE>
LANGCHAIN_PROJECT=<YOUR PROJECT NAME HERE>

OPENAI_API_KEY=<YOUR API KEY HERE>
```

## Usage

See the [official docs](https://phrdang.github.io/findprob/) or run `findprob --help` for more information.

## Credits

A research project for CS 194-271 at UC Berkeley (Fall 2024) created by:

- Rebecca Dang (rdang [at] berkeley [dot] edu)
- Jessica Lin (linjessica [at] berkeley [dot] edu)
- Samantha Huang (samanthahuang [at] berkeley [dot] edu)

Advised by:

- Professor Gireeja Ranade (ranade [at] eecs [dot] berkeley [dot] edu)
- Professor Narges Norouzi (norouzi [at] berkeley [dot] edu)
