Metadata-Version: 2.1
Name: promptflow-gui
Version: 0.1.4
Summary: Create flowcharts to control LLMs
Author-email: Sawyer McLane <sawyer@fextoolkit.com>
License: MIT License
        
        Copyright (c) 2023 Insurance Toolkits, LLC
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://www.promptflow.org/en/latest/
Keywords: prompt,llm,flowchart,flow,chart,promptflow
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE


<p align="center">
  <img src="promptflow/res/Logo_full_1.png" alt="PromptFlow logo"/>
</p>

---

# 🧩💡 PromptFlow

Want to quickly prototype your Large Language Model (LLM) application without a ton of code? Unleash your creativity with **PromptFlow**, a low-code tool that empowers you to craft executable flowcharts. Seamlessly integrate LLMs, prompts, Python functions, and conditional logic to create intricate workflows. With PromptFlow, you can visualize your ideas and bring them to life, all without getting tangled in code or complex logic.

<p align="center">
  <img src="screenshots/readme/heroscreenshot.png" alt="PromptFlow screenshot"/>
</p>

#### 🎮 Join the conversation on our [Discord Server](https://discord.gg/5MmV3FNCtN)

## 🔗 How it works

The core of PromptFlow is a visual flowchart editor that lets you design nodes and establish Connections between them. Each node can represent a Prompt, a Python function, or an LLM. The connections between nodes embody conditional logic, dictating the flow of your program.

When run your flowchart, PromptFlow executes each node in the sequence defined by the connections, transferring text data between nodes as required. If a node returns a value, that value is forwarded to the next node in the flow as a string. More information on the inner workings of PromptFlow can be found in our [documentation](https://www.promptflow.org/en/latest/).

## 🛠️ Initial Setup 

Kickstart your PromptFlow journey by installing the required dependencies. Python 3.8+ is required to run PromptFlow.

```bash
python -m pip install -r requirements.txt
```

Encountered a hiccup? Try this instead:

```bash
python -m pip install -r requirements-no-nvidia.txt
```

## 🚀 Launching

Fire up PromptFlow with Python from the command line:

```bash
python run.py 
```

If you're hitting a roadblock, ensure your `PYTHONPATH` is set correctly:

```bash
export PYTHONPATH=$PYTHONPATH:.
```

## 📚 Documentation

[![Documentation Status](https://readthedocs.org/projects/promptflow/badge/?version=latest)](https://www.promptflow.org/en/latest/?badge=latest)

Check out our official docs:

#### 🌐 [promptflow.org](https://www.promptflow.org/en/latest/)

### 🏗️ Building from source

To compile the Sphinx documentation, execute:

```bash
cd docs
make html
```

Then, navigate to `docs/build/html/index.html` in your browser.

## 🤝 Contributing

Want to contribute to PromptFlow? Get started by [building a node](https://www.promptflow.org/en/latest/development.html#starting-point-adding-a-node).

Stumbled upon a bug? Don't hesitate to create an issue, open a PR, or let us know on [Discord](https://discord.gg/5MmV3FNCtN).
