Metadata-Version: 2.1
Name: ppig
Version: 0.1.2
Summary: An AI terminal assistant
Author: Miguel Martín
Author-email: miguel.martinr11@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: click (>=8.1.3,<9.0.0)
Requires-Dist: flask (>=2.2.3,<3.0.0)
Requires-Dist: openai (>=0.27.2,<0.28.0)
Requires-Dist: pyperclip (>=1.8.2,<2.0.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Description-Content-Type: text/markdown

# PPIG: A simple AI terminal assistant

Example:

* Input:

```bash
➜ ppig list only directories        

      ls -d */
The command has been copied to the clipboard

➜ 
```

Make sure your device has some sort of clipboard system such as `xclip`. If it doesn't you can install it executing: 

```bash
➜ sudo apt-get install xclip
```

## Config
`ppig` uses OpenAI API. In order to use this API you need to be signed up in OpenAI as well as an API key. ([get it here](https://platform.openai.com/account/api-keys))

Once you have your API key, you have two options:

1. Create a `ppig_cfg.yaml` file in the directory from which you will call `ppig`. Choosing this option you won't be able to use ppig outside of that foler.
2. Create the path `~/.ppig/ppig_cfg.yaml`. Choosing this option you will be able to use ppig from any folder.

In both cases, the `ppig_cfg.yaml` muste be like this:

```YAML
api_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```

Replace `XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX` with your API key.





