Metadata-Version: 2.3
Name: findprob
Version: 0.1
Summary: A CLI that lets you classify and search for problems by topic using an LLM
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>
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: typer>=0.12.3
Description-Content-Type: text/markdown

# findprob

## Installation

```sh
pip install findprob
```

## Usage

```sh
findprob config
findprob classify
findprob search
```

## Development

1. Clone the repository: `git clone git@github.com:phrdang/findprob.git`
2. Create virtual environment: `python3 -m venv env`
3. Activate virtual environment: `source env/bin/activate`
4. Install `hatch`: https://hatch.pypa.io/1.9/install/
5. Install dependencies: `pip install -r requirements.txt`
    1. If you install new dependencies, make sure to run `pip freeze > requirements.txt`
6. Install the `findprob` package: `pipx install findprob`
7. Use the CLI as you would normally, e.g. `findprob <command> <options> <arguments>`
8. Very jank way to manually test the CLI at the moment: If you make changes you'll have to `pipx uninstall .` and `pipx install .`
9. Publishing to [PyPi](https://pypi.org/): https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#packaging-your-project
