gpterminator


Namegpterminator JSON
Version 0.1.10 PyPI version JSON
download
home_pagehttps://github.com/AineeJames/ChatGPTerminator
SummarySee https://github.com/AineeJames/ChatGPTerminator for more details!
upload_time2023-04-06 18:46:25
maintainer
docs_urlNone
authorAiden Olsen
requires_python
licenseLICENSE
keywords chatgpt cli python
VCS
bugtrack_url
requirements inquirer openai prompt_toolkit pyperclip rich tiktoken
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">GPTerminator :robot: - ChatGPT in the Terminal!</h1>
<p align="center">
<img src="./imgs/panel_output.png" width="600" />
</p>
<p align="center">GPTerminator provides a convenient way to interact with OpenAI's chat completion and image generation API's using your command line interface.</p>
<p align="center">
<img src="https://img.shields.io/github/last-commit/AineeJames/ChatGPTerminator?style=for-the-badge&logo=github&color=7dc4e4&logoColor=D9E0EE&labelColor=302D41" />
<img src="https://img.shields.io/github/stars/AineeJames/ChatGPTerminator?style=for-the-badge&logo=apachespark&color=eed49f&logoColor=D9E0EE&labelColor=302D41" />
</p>

## Features :sparkles:

- :mag: Chat completion 
- :floppy_disk: Save and load chat sessions 
- :bar_chart: File analysis 
- :art: Image generation with Dalle 
- :clipboard: Easy code and text copying using 
- :repeat: Regeneration of responses

## Getting Started & Installation :rocket:

### To use this terminal interface, follow these steps:

#### 1) Install GPTerminator
```zsh
git clone https://github.com/AineeJames/ChatGPTerminator
cd ChatGPTerminator
pip install .
```
or
```zsh
pip install gpterminator
```
#### 2) Set the OPENAI_API_KEY env variable (you may want this in your .rc file):
```zsh
export OPENAI_API_KEY=PUT_API_KEY_HERE
```
#### 3) Run the following command to start the ChatGPT terminal interface:
```zsh
gpterm
```
#### 4) You can now start chatting. Type a message and press Enter to get a response.
#### 5) Type `!help` for a list of commands to use

## Running with podman/docker (optional) :package:
#### Build the image and provide the `APIKEY`
```bash
podman build \ 
	--build-arg APIKEY=$(echo $OPENAI_API_KEY) \ 
	-t gpterm .
```
#### Run gpterm in the container
```bash
podman run -it --rm --name gpterm gpterm 
```
#### Set an alias for easy access
```bash
echo "alias gpterm='podman run -it --rm --name gpterm gpterm'" >> ~/.bashrc
```

## Commands :exclamation:

- Power up you chat experience with commands!
- By typing `!help` you can view all the possible commands along with a short desctiption.
- Please check out the [wiki](https://github.com/AineeJames/ChatGPTerminator/wiki/Commands) for more detailed help with commands!

## Configuration :gear:

The config.ini directory resides in different locations dependent on your OS. In order to find the path, run GPTerminator and then type `!pconf`.

GPTerminator is configurable and can support multiple configurations. Add the following to your config.ini:

   ```ini
   [CONFIG_TEMPLATE]
   ModelName = 
   SystemMessage = 
   Temperature =
   PresencePenalty = 
   FrequencyPenalty = 
   CommandInitiator = 
   SavePath = 
   ```

- **ModelName:** this is the model used when chatting
- **Temperature** = between 0 and 2
- **PresencePenalty** = between -2 and 2
- **FrequencyPenalty** = between -2 and 2
- **SystemMessage:** this is the starting system message sent to the API
- **CommandInitiator:** this can be set to change the default !<cmd> structure
- **SavePath:** this changes the location of the save path when loading/saving

_Note_: More details on some settings can be found [here](https://platform.openai.com/docs/api-reference/chat/create)

After saving the config file, run: `gpterm`
Then, type !setconf and select which config you wish to use, you can also run the !pconf commang to view the current config details.

_Note_: If you change the CommandInitiator, you will now type <CommandInitiator><cmd> to execute commands...


## Contributing :raised_hands:

### Current Contributors:


<a href="https://github.com/AineeJames/ChatGPTerminator/graphs/contributors">
<img src="https://contrib.rocks/image?repo=AineeJames/ChatGPTerminator" />
</a>


We welcome contributions to this project. If you find a bug, have a feature request, or want to contribute code, please open an issue or submit a pull request.

## Disclaimer :warning: 

This program uses the openai API to chat and generate images using dalle. It is a good idea to put a usage cap on your billing, just in case something goes wrong!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/AineeJames/ChatGPTerminator",
    "name": "gpterminator",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "chatgpt cli python",
    "author": "Aiden Olsen",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c8/b6/09a42354aa00b253bfd560b54404d1e957ae7db5eb452aa202d36243db23/gpterminator-0.1.10.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">GPTerminator :robot: - ChatGPT in the Terminal!</h1>\n<p align=\"center\">\n<img src=\"./imgs/panel_output.png\" width=\"600\" />\n</p>\n<p align=\"center\">GPTerminator provides a convenient way to interact with OpenAI's chat completion and image generation API's using your command line interface.</p>\n<p align=\"center\">\n<img src=\"https://img.shields.io/github/last-commit/AineeJames/ChatGPTerminator?style=for-the-badge&logo=github&color=7dc4e4&logoColor=D9E0EE&labelColor=302D41\" />\n<img src=\"https://img.shields.io/github/stars/AineeJames/ChatGPTerminator?style=for-the-badge&logo=apachespark&color=eed49f&logoColor=D9E0EE&labelColor=302D41\" />\n</p>\n\n## Features :sparkles:\n\n- :mag: Chat completion \n- :floppy_disk: Save and load chat sessions \n- :bar_chart: File analysis \n- :art: Image generation with Dalle \n- :clipboard: Easy code and text copying using \n- :repeat: Regeneration of responses\n\n## Getting Started & Installation :rocket:\n\n### To use this terminal interface, follow these steps:\n\n#### 1) Install GPTerminator\n```zsh\ngit clone https://github.com/AineeJames/ChatGPTerminator\ncd ChatGPTerminator\npip install .\n```\nor\n```zsh\npip install gpterminator\n```\n#### 2) Set the OPENAI_API_KEY env variable (you may want this in your .rc file):\n```zsh\nexport OPENAI_API_KEY=PUT_API_KEY_HERE\n```\n#### 3) Run the following command to start the ChatGPT terminal interface:\n```zsh\ngpterm\n```\n#### 4) You can now start chatting. Type a message and press Enter to get a response.\n#### 5) Type `!help` for a list of commands to use\n\n## Running with podman/docker (optional) :package:\n#### Build the image and provide the `APIKEY`\n```bash\npodman build \\ \n\t--build-arg APIKEY=$(echo $OPENAI_API_KEY) \\ \n\t-t gpterm .\n```\n#### Run gpterm in the container\n```bash\npodman run -it --rm --name gpterm gpterm \n```\n#### Set an alias for easy access\n```bash\necho \"alias gpterm='podman run -it --rm --name gpterm gpterm'\" >> ~/.bashrc\n```\n\n## Commands :exclamation:\n\n- Power up you chat experience with commands!\n- By typing `!help` you can view all the possible commands along with a short desctiption.\n- Please check out the [wiki](https://github.com/AineeJames/ChatGPTerminator/wiki/Commands) for more detailed help with commands!\n\n## Configuration :gear:\n\nThe config.ini directory resides in different locations dependent on your OS. In order to find the path, run GPTerminator and then type `!pconf`.\n\nGPTerminator is configurable and can support multiple configurations. Add the following to your config.ini:\n\n   ```ini\n   [CONFIG_TEMPLATE]\n   ModelName = \n   SystemMessage = \n   Temperature =\n   PresencePenalty = \n   FrequencyPenalty = \n   CommandInitiator = \n   SavePath = \n   ```\n\n- **ModelName:** this is the model used when chatting\n- **Temperature** = between 0 and 2\n- **PresencePenalty** = between -2 and 2\n- **FrequencyPenalty** = between -2 and 2\n- **SystemMessage:** this is the starting system message sent to the API\n- **CommandInitiator:** this can be set to change the default !<cmd> structure\n- **SavePath:** this changes the location of the save path when loading/saving\n\n_Note_: More details on some settings can be found [here](https://platform.openai.com/docs/api-reference/chat/create)\n\nAfter saving the config file, run: `gpterm`\nThen, type !setconf and select which config you wish to use, you can also run the !pconf commang to view the current config details.\n\n_Note_: If you change the CommandInitiator, you will now type <CommandInitiator><cmd> to execute commands...\n\n\n## Contributing :raised_hands:\n\n### Current Contributors:\n\n\n<a href=\"https://github.com/AineeJames/ChatGPTerminator/graphs/contributors\">\n<img src=\"https://contrib.rocks/image?repo=AineeJames/ChatGPTerminator\" />\n</a>\n\n\nWe welcome contributions to this project. If you find a bug, have a feature request, or want to contribute code, please open an issue or submit a pull request.\n\n## Disclaimer :warning: \n\nThis program uses the openai API to chat and generate images using dalle. It is a good idea to put a usage cap on your billing, just in case something goes wrong!\n",
    "bugtrack_url": null,
    "license": "LICENSE",
    "summary": "See https://github.com/AineeJames/ChatGPTerminator for more details!",
    "version": "0.1.10",
    "split_keywords": [
        "chatgpt",
        "cli",
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e26d68daa76d2323378c2de8cd4940ea661be7793f3a70c553c54deae025c5cf",
                "md5": "053ae652c1ac3ecd21cc268467487517",
                "sha256": "e0776fbb48e08036b43df91145eefa42afecb0ea93dafb2101c926936c3222ab"
            },
            "downloads": -1,
            "filename": "gpterminator-0.1.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "053ae652c1ac3ecd21cc268467487517",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9553,
            "upload_time": "2023-04-06T18:46:24",
            "upload_time_iso_8601": "2023-04-06T18:46:24.181988Z",
            "url": "https://files.pythonhosted.org/packages/e2/6d/68daa76d2323378c2de8cd4940ea661be7793f3a70c553c54deae025c5cf/gpterminator-0.1.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c8b609a42354aa00b253bfd560b54404d1e957ae7db5eb452aa202d36243db23",
                "md5": "c9702322f0b10de69347ceb29af61dc1",
                "sha256": "b226629cefe0465fd694aa88dc300a6afa2b5db954e3de0a938dcb6bcfb9a322"
            },
            "downloads": -1,
            "filename": "gpterminator-0.1.10.tar.gz",
            "has_sig": false,
            "md5_digest": "c9702322f0b10de69347ceb29af61dc1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10487,
            "upload_time": "2023-04-06T18:46:25",
            "upload_time_iso_8601": "2023-04-06T18:46:25.305227Z",
            "url": "https://files.pythonhosted.org/packages/c8/b6/09a42354aa00b253bfd560b54404d1e957ae7db5eb452aa202d36243db23/gpterminator-0.1.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-06 18:46:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "AineeJames",
    "github_project": "ChatGPTerminator",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "inquirer",
            "specs": [
                [
                    "==",
                    "3.1.3"
                ]
            ]
        },
        {
            "name": "openai",
            "specs": [
                [
                    "==",
                    "0.27.2"
                ]
            ]
        },
        {
            "name": "prompt_toolkit",
            "specs": [
                [
                    "==",
                    "3.0.38"
                ]
            ]
        },
        {
            "name": "pyperclip",
            "specs": [
                [
                    "==",
                    "1.8.2"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    "==",
                    "13.3.2"
                ]
            ]
        },
        {
            "name": "tiktoken",
            "specs": [
                [
                    "==",
                    "0.3.1"
                ]
            ]
        }
    ],
    "lcname": "gpterminator"
}
        
Elapsed time: 0.05774s