Metadata-Version: 2.4
Name: cmc-csci040-isaiah-bingham-docsum
Version: 0.1.0
Summary: A terminal assistant for chatting with local documents.
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: groq
Requires-Dist: python-dotenv
Provides-Extra: dev
Requires-Dist: coverage; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# Groq O' Clock

[![doctest](https://github.com/isaiah-debug/groq-o-clock-personal-python-chatbot-project/actions/workflows/doctest.yml/badge.svg)](https://github.com/isaiah-debug/groq-o-clock-personal-python-chatbot-project/actions/workflows/doctest.yml)
[![integration-test](https://github.com/isaiah-debug/groq-o-clock-personal-python-chatbot-project/actions/workflows/integration-test.yml/badge.svg)](https://github.com/isaiah-debug/groq-o-clock-personal-python-chatbot-project/actions/workflows/integration-test.yml)
[![flake8](https://github.com/isaiah-debug/groq-o-clock-personal-python-chatbot-project/actions/workflows/flake8.yml/badge.svg)](https://github.com/isaiah-debug/groq-o-clock-personal-python-chatbot-project/actions/workflows/flake8.yml)
[![coverage](https://codecov.io/gh/isaiah-debug/groq-o-clock-personal-python-chatbot-project/branch/main/graph/badge.svg)](https://codecov.io/gh/isaiah-debug/groq-o-clock-personal-python-chatbot-project)
[![PyPI](https://img.shields.io/badge/pypi-not%20published-lightgrey)](https://github.com/isaiah-debug/groq-o-clock-personal-python-chatbot-project)

Lets get to grokkin'

![demo](demo.gif)

```text
$ chat
chat> /ls .github
workflows
chat> /calculate 6 * 7
42
```

## Test Projects

### Webpage Project

```text
$ cd test_projects/webpage
$ chat
chat> what does this project do?
This project creates a personal website. It contains HTML, CSS, and JavaScript files that build a responsive portfolio site.
```

This example demonstrates the chat tool reading and comprehending project documentation automatically through the `cat` tool.

### Markdown Compiler Project

```text
$ cd test_projects/markdown_compiler
$ chat
chat> does this project use regular expressions?
No, I searched all .py files and found no imports of the `re` module.
```

This example shows the LLM using the `grep` tool automatically to search for regex imports across the project, proving it can reason about code patterns.

### eBay Scraper Project

```text
$ cd test_projects/ebay_scraper
$ chat
chat> tell me about this project
This is a web scraper designed to extract product information from eBay listings, including titles, prices, and seller information.
```

This example demonstrates the LLM reading and summarizing the project's README to give an accurate overview of the project's purpose.
