Metadata-Version: 2.1
Name: aishell
Version: 2023.3.2
Summary: 
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: openai (>=0.26.5,<0.27.0)
Requires-Dist: poetry (>=1.3.1,<2.0.0)
Requires-Dist: pydantic (>=1.10.4,<2.0.0)
Requires-Dist: pyright (>=1.1.294,<2.0.0)
Requires-Dist: revchatgpt (>=2.2.7,<3.0.0)
Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
Description-Content-Type: text/markdown

# AiShell 🤖

[![Release Package to PyPI](https://github.com/code-yeongyu/AiShell/actions/workflows/release.yml/badge.svg)](https://github.com/code-yeongyu/AiShell/actions/workflows/release.yml)
[![PyPI version](https://badge.fury.io/py/aishell.svg)](https://badge.fury.io/py/aishell)


A simple Python code that connects to OpenAI's ChatGPT and executes the returned results.

## Key Features 💡

- Interact with your computer using natural language
- Automatically executes the command from the response of ChatGPT
- Good for complex tasks like handling Git and extracting tar files
- No need to search StackOverflow for commands, AiShell has got you covered

### Simple Utility commands 🛠

[![utility](https://asciinema.org/a/556670.svg)](https://asciinema.org/a/556670?speed=5)

### A powerful git assistant 💪🏻👨‍💻💻

[![git assistant](https://asciinema.org/a/556677.svg)](https://asciinema.org/a/556677?speed=5)

## Installation 🔧

```sh
pip install aishell
```

## Usage 📝

```sh
python -m aishell --help
```

## Prerequisites 📚

- Python 3.9.5
- Poetry
- OpenAI API Key

## Getting Started 🚀

1. Create account on OpenAI
1. Go to <https://platform.openai.com/account/api-keys>, Copy API key
1. Set the API key as an environment variable `OPENAI_API_KEY` or inject it directly into the code by editing it.
1. [Install](#installation)

## Contributions 💬

Feel free to contribute to AiShell by adding more functionality or fixing bugs.

