rubberduck-ai


Namerubberduck-ai JSON
Version 0.5.7 PyPI version JSON
download
home_pagehttps://github.com/hansololz/rubberduck-ai
SummaryA CLI tool for ChatGPT.
upload_time2023-03-22 04:15:35
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/59/ac/0b9330238616b55323d3bafe291e003abbd00fcaa91d79e59da05a4fa9a2/rubberduck-ai-0.5.7.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.5.7",
    "split_keywords": [
        "rda",
        "openai",
        "chatgpt",
        "chat"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eccf46db9f6bb62d8306edec4b854c5c8720613de0b97d2cf6bce7eb2b0ba946",
                "md5": "7601ff41e51bb3976d6c87e8bb6e0e2a",
                "sha256": "e981d5ea0e9f873e3e7ca5e116cb1f67d80be2a4232df617eb1c507c298ef2ba"
            },
            "downloads": -1,
            "filename": "rubberduck_ai-0.5.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7601ff41e51bb3976d6c87e8bb6e0e2a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 26253,
            "upload_time": "2023-03-22T04:15:32",
            "upload_time_iso_8601": "2023-03-22T04:15:32.459402Z",
            "url": "https://files.pythonhosted.org/packages/ec/cf/46db9f6bb62d8306edec4b854c5c8720613de0b97d2cf6bce7eb2b0ba946/rubberduck_ai-0.5.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "59ac0b9330238616b55323d3bafe291e003abbd00fcaa91d79e59da05a4fa9a2",
                "md5": "48fd2af501194ed94493106dd55e2aa6",
                "sha256": "f08c147e4eeebee4c3febb1b9cc42e6db58ae2693de4aa48a0bff323718c8e7d"
            },
            "downloads": -1,
            "filename": "rubberduck-ai-0.5.7.tar.gz",
            "has_sig": false,
            "md5_digest": "48fd2af501194ed94493106dd55e2aa6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 23071,
            "upload_time": "2023-03-22T04:15:35",
            "upload_time_iso_8601": "2023-03-22T04:15:35.602597Z",
            "url": "https://files.pythonhosted.org/packages/59/ac/0b9330238616b55323d3bafe291e003abbd00fcaa91d79e59da05a4fa9a2/rubberduck-ai-0.5.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-22 04:15:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "hansololz",
    "github_project": "rubberduck-ai",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "rubberduck-ai"
}
        
Elapsed time: 0.12852s