rubberduck-ai


Namerubberduck-ai JSON
Version 0.6.0 PyPI version JSON
download
home_pagehttps://github.com/hansololz/rubberduck-ai
SummaryA CLI tool for ChatGPT.
upload_time2023-07-11 21:54:01
maintainer
docs_urlNone
author
requires_python>=3.5
licenseGPL
keywords rda openai chatgpt chat
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ChatGPT CLI Client

## Installation

### Manual Installation

    git clone https://github.com/hansololz/rubberduck-ai.git
    cd rubberduck-ai
    python setup.py install

### Installation (pip)

    pip install rubberduck-ai

## Authentication

### Authentication Token
The CLI tool requires Open AI authentication token. Token can be obtained 
by going to https://platform.openai.com/account/api-keys.

### Authentication Methods
Choose one of these options to authenticate the CLI tool:
- Set the environment variable: `OPENAI_API_KEY=<AUTHENTICATION_TOKEN>`.
- Use a command argument: `rda --openai-api-key=<AUTHENTICATION_TOKEN>`.
- Enter the API key when prompted while running the CLI tool.

## Usage

### Evaluation Loop
Run the application:
    
    rda

#### Supported Commands
- .n .new: Create new session
- .p .print: Print current session 
- .s .sessions: Change chat session
- cd clear ls: Session supported bash commands
- cd cls dir: Session supported cmd commands

### Single Prompt
Process a single prompt with:

    rda <SINGLE_PROMPT> --openai-api-key=<AUTHENTICATION_TOKEN>

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hansololz/rubberduck-ai",
    "name": "rubberduck-ai",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "rda,openai,ChatGPT,chat",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/68/84/92aaba7e31d1acc0c73736863e9fe1f5524abca07873451ec5f36136d4e3/rubberduck-ai-0.6.0.tar.gz",
    "platform": null,
    "description": "# ChatGPT CLI Client\n\n## Installation\n\n### Manual Installation\n\n    git clone https://github.com/hansololz/rubberduck-ai.git\n    cd rubberduck-ai\n    python setup.py install\n\n### Installation (pip)\n\n    pip install rubberduck-ai\n\n## Authentication\n\n### Authentication Token\nThe CLI tool requires Open AI authentication token. Token can be obtained \nby going to https://platform.openai.com/account/api-keys.\n\n### Authentication Methods\nChoose one of these options to authenticate the CLI tool:\n- Set the environment variable: `OPENAI_API_KEY=<AUTHENTICATION_TOKEN>`.\n- Use a command argument: `rda --openai-api-key=<AUTHENTICATION_TOKEN>`.\n- Enter the API key when prompted while running the CLI tool.\n\n## Usage\n\n### Evaluation Loop\nRun the application:\n    \n    rda\n\n#### Supported Commands\n- .n .new: Create new session\n- .p .print: Print current session \n- .s .sessions: Change chat session\n- cd clear ls: Session supported bash commands\n- cd cls dir: Session supported cmd commands\n\n### Single Prompt\nProcess a single prompt with:\n\n    rda <SINGLE_PROMPT> --openai-api-key=<AUTHENTICATION_TOKEN>\n",
    "bugtrack_url": null,
    "license": "GPL",
    "summary": "A CLI tool for ChatGPT.",
    "version": "0.6.0",
    "project_urls": {
        "Homepage": "https://github.com/hansololz/rubberduck-ai"
    },
    "split_keywords": [
        "rda",
        "openai",
        "chatgpt",
        "chat"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c753ed14492ad7f7cf75c6b179011e497f5dad55ca5f8b4c74fd0ebafbfef5af",
                "md5": "4e204cab4e20a3f568f58eba767bcaf6",
                "sha256": "105e5c8aef39047dde2cd34c7e240388fc8620cf29319fc89fed882f66f0e8df"
            },
            "downloads": -1,
            "filename": "rubberduck_ai-0.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4e204cab4e20a3f568f58eba767bcaf6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 26329,
            "upload_time": "2023-07-11T21:53:59",
            "upload_time_iso_8601": "2023-07-11T21:53:59.607532Z",
            "url": "https://files.pythonhosted.org/packages/c7/53/ed14492ad7f7cf75c6b179011e497f5dad55ca5f8b4c74fd0ebafbfef5af/rubberduck_ai-0.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "688492aaba7e31d1acc0c73736863e9fe1f5524abca07873451ec5f36136d4e3",
                "md5": "d7f67f21b7e2be0928951606e0e93db2",
                "sha256": "0d76ec0da39ddbd8fc869a0a546caa0c5b1540f504e53746a61072f523f92d62"
            },
            "downloads": -1,
            "filename": "rubberduck-ai-0.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d7f67f21b7e2be0928951606e0e93db2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 23055,
            "upload_time": "2023-07-11T21:54:01",
            "upload_time_iso_8601": "2023-07-11T21:54:01.223461Z",
            "url": "https://files.pythonhosted.org/packages/68/84/92aaba7e31d1acc0c73736863e9fe1f5524abca07873451ec5f36136d4e3/rubberduck-ai-0.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-11 21:54:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hansololz",
    "github_project": "rubberduck-ai",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "rubberduck-ai"
}
        
Elapsed time: 0.10094s