Metadata-Version: 2.1
Name: zed-assistant
Version: 0.0.1
Summary: Zed is an LLM-based CLI assistant built with python and Chat GPT
Author: Matheus Hoffmann Silva
Author-email: hoffmann.matheus@gmail.com
Requires-Python: >=3.8,<4.0
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
Requires-Dist: colorama (>=0.4.6,<0.5.0)
Requires-Dist: halo (>=0.0.31,<0.0.32)
Requires-Dist: jinja2 (>=3.1.3,<4.0.0)
Requires-Dist: openai (>=1.23.6,<2.0.0)
Description-Content-Type: text/markdown


# Overview 
A helpful command line assistant, based on ChatGPT.

# Installation
Note: Zed requires Python 3.8+
```bash
pip install zed-assistant
```

# Usage
```bash
zed --help
```

## Examples
```bash
zed zip my-folder/
```

# Contributing 
## Install dependencies
Setup the project locally:
```bash
git clone https://github.com/hoffmannmatheus/zed/ && cd zed
poetry install
```

## Run tests
```bash
poetry run pytest
```

## Run zed locally
First, setup your local OpenAI API key: 
```bash
export ZED_OAI_KEY="your-openai-key"
```
Then, run locally with:
```bash
poetry run zed
```

## Publishing a new version
```bash
poetry publish --build
```

