promptimizer

Name	promptimizer JSON
Version	0.1.0 JSON
	download
home_page	https://github.com/Undertone0809/promptimizer
Summary	An elegant LLM prompt optimizer and prompt builder.
upload_time	2023-10-06 19:32:40
maintainer
docs_url	None
author	Zeeland
requires_python	>=3.8
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Promptimizer

Promptimizer is "prompt" + "optimizer", which is a prompt optimizer. It aims to build the high-quality LLM prompts for everyone. It can build and optimize an elegant prompt for you.

We use structured prompt templates to guide LLM in building an efficient prompt that can more accurately output the answers users want.

![usage.png](./docs%2Fimages%2Fusage.png)

# Setup

## Pip (Method1 Recommend)

Open terminal and enter the following command.

```shell
pip install promptimizer
```

Using following command to open client.

```text
promptimizer
```

## Git Clone (Method2)

Clone repo to local.

```shell
git clone https://github.com/Undertone0809/promptimizer
```

Install all relevant packages.

```shell
pip install poetry
poetry install 
```

Copy `.env.example` rename it as `.env`, saving it to the root directory of the current project. Fill in your openai key in `.env`.

```text
OPENAI_API_KEY=your-key
```

Run the script.

```shell
python main.py
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Undertone0809/promptimizer",
    "name": "promptimizer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Zeeland",
    "author_email": "zeeland@foxmail.com",
    "download_url": "https://files.pythonhosted.org/packages/06/d5/f3de5224a3d2d5269ea5a88dea05d31d46874d0932201bf92722a59bc211/promptimizer-0.1.0.tar.gz",
    "platform": null,
    "description": "# Promptimizer\n\nPromptimizer is \"prompt\" + \"optimizer\", which is a prompt optimizer. It aims to build the high-quality LLM prompts for everyone. It can build and optimize an elegant prompt for you.\n\nWe use structured prompt templates to guide LLM in building an efficient prompt that can more accurately output the answers users want.\n\n![usage.png](./docs%2Fimages%2Fusage.png)\n\n# Setup\n\n## Pip (Method1 Recommend)\n\nOpen terminal and enter the following command.\n\n```shell\npip install promptimizer\n```\n\nUsing following command to open client.\n\n```text\npromptimizer\n```\n\n## Git Clone (Method2)\n\nClone repo to local.\n\n```shell\ngit clone https://github.com/Undertone0809/promptimizer\n```\n\nInstall all relevant packages.\n\n```shell\npip install poetry\npoetry install \n```\n\nCopy `.env.example` rename it as `.env`, saving it to the root directory of the current project. Fill in your openai key in `.env`.\n\n```text\nOPENAI_API_KEY=your-key\n```\n\nRun the script.\n\n```shell\npython main.py\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An elegant LLM prompt optimizer and prompt builder.",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/Undertone0809/promptimizer",
        "Repository": "https://github.com/Undertone0809/promptimizer"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "100c037764029b839e8d87270a9ff98c511f508bf21714aee75847c64dd08b9c",
                "md5": "c59d7cd99c85d665d3c2997fb0a48476",
                "sha256": "1e5700de409c2f44b6d777d75933728473058e1e2c9bb01e026c3cf5a3bf2120"
            },
            "downloads": -1,
            "filename": "promptimizer-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c59d7cd99c85d665d3c2997fb0a48476",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5335,
            "upload_time": "2023-10-06T19:32:38",
            "upload_time_iso_8601": "2023-10-06T19:32:38.209483Z",
            "url": "https://files.pythonhosted.org/packages/10/0c/037764029b839e8d87270a9ff98c511f508bf21714aee75847c64dd08b9c/promptimizer-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06d5f3de5224a3d2d5269ea5a88dea05d31d46874d0932201bf92722a59bc211",
                "md5": "447e487f0e2488cec743eda65aa04314",
                "sha256": "b3751014582647dc3a43ebc94cf2e9cbb6374a3de88eca6e74fcce4714be8efd"
            },
            "downloads": -1,
            "filename": "promptimizer-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "447e487f0e2488cec743eda65aa04314",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 4885,
            "upload_time": "2023-10-06T19:32:40",
            "upload_time_iso_8601": "2023-10-06T19:32:40.743155Z",
            "url": "https://files.pythonhosted.org/packages/06/d5/f3de5224a3d2d5269ea5a88dea05d31d46874d0932201bf92722a59bc211/promptimizer-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-06 19:32:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Undertone0809",
    "github_project": "promptimizer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "promptimizer"
}