Metadata-Version: 2.4
Name: flowos
Version: 0.1.1
Summary: A Python package with a built-in web application
Project-URL: Repository, https://github.com/dspraneeth07/FlowOS
Project-URL: Homepage, https://github.com/dspraneeth07/FlowOS
Maintainer-email: Atlantic AI Labs <kishor@techmaticsys.com>
License-Expression: MIT
License-File: LICENSE
Keywords: gpt,gui,langchain,nlp,openai
Requires-Python: <3.15,>=3.10
Requires-Dist: flowos-arxiv>=0.1.1
Requires-Dist: flowos-base[complete]>=0.1.1
Requires-Dist: flowos-docling>=0.1.1
Requires-Dist: flowos-duckduckgo>=0.1.1
Requires-Dist: flowos-ibm>=0.1.1
Provides-Extra: audio
Requires-Dist: webrtcvad>=2.0.10; extra == 'audio'
Provides-Extra: cassio
Requires-Dist: cassio>=0.1.7; extra == 'cassio'
Provides-Extra: clickhouse-connect
Requires-Dist: clickhouse-connect==0.7.19; extra == 'clickhouse-connect'
Provides-Extra: couchbase
Requires-Dist: couchbase>=4.2.1; extra == 'couchbase'
Provides-Extra: docling
Requires-Dist: flowos-docling[local]>=0.1.1; extra == 'docling'
Provides-Extra: docling-chunking
Requires-Dist: flowos-docling[chunking]>=0.1.1; extra == 'docling-chunking'
Provides-Extra: docling-image-description
Requires-Dist: flowos-docling[image-description]>=0.1.1; extra == 'docling-image-description'
Provides-Extra: local
Requires-Dist: ctransformers>=0.2.10; extra == 'local'
Requires-Dist: sentence-transformers>=2.3.1; extra == 'local'
Provides-Extra: nv-ingest
Requires-Dist: nv-ingest-api<27.0.0,>=26.1.0; (python_version >= '3.12') and extra == 'nv-ingest'
Requires-Dist: nv-ingest-client<27.0.0,>=26.1.0; (python_version >= '3.12') and extra == 'nv-ingest'
Provides-Extra: postgresql
Requires-Dist: sqlalchemy[postgresql-psycopg2binary]<3.0.0,>=2.0.38; extra == 'postgresql'
Requires-Dist: sqlalchemy[postgresql-psycopg]<3.0.0,>=2.0.38; extra == 'postgresql'
Description-Content-Type: text/markdown

<!-- markdownlint-disable MD030 -->

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="./docs/static/img/flowos-logo-color-blue-bg.svg">
  <img src="./docs/static/img/flowos-logo-color-black-solid.svg" alt="FlowOS logo">
</picture>

[![Release Notes](https://img.shields.io/github/release/flowos-ai/flowos?style=flat-square)](https://github.com/flowos-ai/flowos/releases)
[![PyPI - License](https://img.shields.io/badge/license-MIT-orange)](https://opensource.org/licenses/MIT)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/flowos?style=flat-square)](https://pypistats.org/packages/flowos)
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/flowos-ai.svg?style=social&label=Follow%20%40FlowOS)](https://twitter.com/flowos_ai)
[![YouTube Channel](https://img.shields.io/youtube/channel/subscribers/UCn2bInQrjdDYKEEmbpwblLQ?label=Subscribe)](https://www.youtube.com/@FlowOS)
[![Discord Server](https://img.shields.io/discord/1116803230643527710?logo=discord&style=social&label=Join)](https://discord.gg/EqksyE2EX9)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/flowos-ai/flowos)

[FlowOS](https://flowos.org) is a powerful platform for building and deploying AI-powered agents and workflows. It provides developers with both a visual authoring experience and built-in API and MCP servers that turn every workflow into a tool that can be integrated into applications built on any framework or stack. FlowOS comes with batteries included and supports all major LLMs, vector databases and a growing library of AI tools.

## ✨ Highlight features

- **Visual builder interface** to quickly get started and iterate.
- **Source code access** lets you customize any component using Python.
- **Interactive playground** to immediately test and refine your flows with step-by-step control.
- **Multi-agent orchestration** with conversation management and retrieval.
- **Deploy as an API** or export as JSON for Python apps.
- **Deploy as an MCP server** and turn your flows into tools for MCP clients.
- **Observability** with LangSmith, LangFuse and other integrations.
- **Enterprise-ready** security and scalability.

## 🖥️  FlowOS Desktop

FlowOS Desktop is the easiest way to get started with FlowOS. All dependencies are included, so you don't need to manage Python environments or install packages manually.
Available for Windows and macOS.

[📥 Download FlowOS Desktop](https://www.flowos.org/desktop)

## ⚡️ Quickstart

### Install locally (recommended)

Requires Python 3.10–3.14 and [uv](https://docs.astral.sh/uv/getting-started/installation/) (recommended package manager).

#### Install

From a fresh directory, run:
```shell
uv pip install flowos -U
```

The latest FlowOS package is installed.
For more information, see [Install and run the FlowOS OSS Python package](https://docs.flowos.org/get-started-installation#install-and-run-the-flowos-oss-python-package).

#### Run

To start FlowOS, run:
```shell
uv run flowos run
```

FlowOS starts at http://127.0.0.1:7860.

That's it! You're ready to build with FlowOS! 🎉

## 📦 Other install options

### Run from source
If you've cloned this repository and want to contribute, run this command from the repository root:
```shell
make run_cli
```
For more information, see [DEVELOPMENT.md](./DEVELOPMENT.md).

### Docker
Start a FlowOS container with default settings:
```shell
docker run -p 7860:7860 flowosai/flowos:latest
```
FlowOS is available at http://localhost:7860/.
For configuration options, see the [Docker deployment guide](https://docs.flowos.org/deployment-docker).

## 🛡️ Security

For security information, see our [Security Policy](./SECURITY.md).

## 🚀 Deployment

FlowOS is completely open source and you can deploy it to all major deployment clouds. To learn how to deploy FlowOS, see our [FlowOS deployment guides](https://docs.flowos.org/deployment-overview).

## ⭐ Stay up-to-date

Star FlowOS on GitHub to be instantly notified of new releases.

![Star FlowOS](https://github.com/user-attachments/assets/03168b17-a11d-4b2a-b0f7-c1cce69e5a2c)

## 👋 Contribute

We welcome contributions from developers of all levels. If you'd like to contribute, please check our [contributing guidelines](./CONTRIBUTING.md) and help make FlowOS more accessible.

---

[![Star History Chart](https://api.star-history.com/svg?repos=flowos-ai/flowos&type=Timeline)](https://star-history.com/#flowos-ai/flowos&Date)

## ❤️ Contributors

[![flowos contributors](https://contrib.rocks/image?repo=flowos-ai/flowos)](https://github.com/flowos-ai/flowos/graphs/contributors)
