Metadata-Version: 2.1
Name: cgpt
Version: 1.2.4
Summary: Cgpt
Home-page: https://github.com/ainayves/cgpt
License: MIT
Author: Aina Yves
Author-email: randrianaina.yves@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=8.0.1)
Project-URL: Changelog, https://github.com/ainayves/cgpt/releases
Project-URL: Documentation, https://cgpt.readthedocs.io
Project-URL: Repository, https://github.com/ainayves/cgpt
Description-Content-Type: text/markdown

![PyPI](https://img.shields.io/pypi/v/cgpt)
![python](https://img.shields.io/badge/Python-3.7-blue.svg)
![commit activity](https://img.shields.io/github/commit-activity/m/ainayves/cgpt?color=blue)
[![Build Status](https://img.shields.io/badge/Build%20status-Passing-green)](https://github.com/ainayves/cgpt/actions)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

<center><h1>🤖 MAKE AI POWERED SEARCH INSIDE YOUR CLI 💻</h1></center>
</br>

### ⭐ FEATURES

- [AI conversation exactly the same as in openai website](#description)
- [LAN support](#link-cgpt-inside-a-local-network)
- [Docker support](#whale2-build-and-run-with-docker)

</br>

![cgpt1 1 28 (1)](https://user-images.githubusercontent.com/66997516/232239452-27e5c840-5699-44b8-bb28-da8d2dabc64f.gif)

</br>

### DESCRIPTIONS

- `cgpt` is a Python package that allows you to use AI directly in your favorite Terminal.
- `cgpt` is based on [CLICK](https://github.com/pallets/click) for creating beautiful command line interfaces in a composable way.

### :question: REQUIREMENTS

- python >=3.7
- openai API KEY :
  You need to register on openai to receive your own api key , here : [api_key](https://platform.openai.com/account/api-keys).

### INSTALL FROM PYPI

You can install the latest version from pypi.

```
pip install cgpt
```

### 🖥️ SETUP FOR DEVELOPPERS

```
pip install -r requirements.txt
```

### 🔨 BUILD

- For this part , it is better to use Linux.

If you are on Linux , launch:

```
sudo chmod +x build.sh
```

Then , :

```
./build.sh
```

### ⏯️ VERIFY INSTALLATION

```
cgpt-version
```

### 🚀 RUN

```
cgpt
```

### :link: CGPT INSIDE A LOCAL NETWORK

You can use cgpt inside a LAN.

- You just need one Host (`connected to internet`) to be the server.
- Other Hosts (`not connected to internet`) can ALWAYS use Chat GPT as `client`.

NOTES :

- For now , a server must be launched inside a `Linux` computer . If the server is inside `Windows` : the address is sometimes wrong (to be fixed in the next version).

- Also , make sure that your `/etc/hosts` is configured correctly like :

```
127.0.0.1	localhost
127.0.1.1	your-hostanme
```

- A `client` can also use his own api_key in the next version.

### :whale2: BUILD AND RUN WITH DOCKER

- To make it easier , use the `docker-compose.yml` file :

```
docker-compose run --rm app
```

### 💚 Feedback

Please feel free to leave feedback in issues/PRs.

