Metadata-Version: 2.1
Name: oai-tools
Version: 0.1.1
Summary: Collection of useful tools built on top of OpenAI's API
Home-page: https://github.com/filipgrano/oai_tools/tree/main
Author: Filip Granö
Author-email: filip-accounts@grano.me
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: openai (>=0.27.0)
Requires-Dist: PyYAML
Requires-Dist: types-PyYAML

# OAI Tools

This repository contains a collection of useful tools built on top of OpenAI's API. These tools can help automate various tasks and provide assistance through natural language processing.

## Installation
`pip install .`

## Tools

1. **cligpt**: A command-line helper that takes a user prompt and returns shell commands, along with explanations of what they do. See [cligpt.md](doc/cligpt.md) for more details.

## Configuration
Configuration file is read from `~/.config/oai_tools/config.yaml` file. See the [config-example.yaml](doc/config-example.yaml) file for more details.

### API Key
OpenAI's API key is required. 
The key is read from the `OPENAI_API_KEY` environment variable. If this variable is not set, the API key is read from the `~/.config/oai_tools/api_key` file.


