Skip to main content

nsflow - A FastAPI powered client and IDE for Neuro-San

A fastapi and react based developer-oriented client and IDE that enables users to explore, visualize, and interact with smart agent networks. It integrates with NeuroSan for intelligent agent-based interactions.

[!TIP] To see how nsflow works in conjunction with the neuro-san library, visit https://github.com/cognizant-ai-lab/neuro-san-studio [!TIP] For a production oriented client for neuro-san, visit https://github.com/cognizant-ai-lab/neuro-san-ui

Intro

nsflow comes with an Agent Network Designer that embodies the agentic design philosophy, making the neuro-san library accessible to both developers and non-developers alike. This transforms nsflow from a simple interactive chat client into a well-featured agent orchestration platform with visual design capabilities.

Project Snapshot


Enabling/Disabling text-to-speech and speech-to-text

For local development (when running the backend and frontend separately), you can toggle text-to-speech and speech-to-text by setting the VITE_USE_SPEECH variable in the nsflow/frontend/.env.development file to "true" or "false". The frontend development server reads this file directly.


Installation & Running nsflow

nsflow can be installed and run in two different ways:

1️⃣ Run nsflow using pypi package

To simplify execution, nsflow provides a CLI command to start both the backend and frontend simultaneously.

Step 1: Create and source a virtual environment

python -m venv .venv
source .venv/bin/activate

Step 2: Install nsflow from pip

pip install nsflow

Step 3: Run Everything with a Single Command

python -m nsflow.run

By default, this will start:

  • backend (FastAPI + NeuroSan) here: http://127.0.0.1:4173/docs or http://127.0.0.1:4173/redoc
  • frontend (React) here: http://127.0.0.1:4173

2️⃣ Development & Contribution (Manually Start Frontend & Backend)

If you want to contribute, ensure you have the necessary dependencies installed. To start the frontend and backend separately, follow these steps:

Step 1: Clone the Repository

git clone https://github.com/cognizant-ai-lab/nsflow.git
cd nsflow

Step 2: Install Dependencies

  • Make sure you have python (preferably Python 3.12) installed.

    python -m venv .venv
    source .venv/bin/activate
    pip install -r requirements.txt
    pip install -r requirements-build.txt
    

Step 3: Start the Backend in dev mode & Frontend separately

  • Ensure that you have a few example hocon files in your registries and the same mapped in registries/manifest.

  • [Optional] Ensure that you have the necessary coded tools in the coded_tools dir.

  • From the root start Backend:

    python -m nsflow.run --dev
    
  • Start Frontend:

    • Ensure that you have Node.js (with Yarn) installed.

    • Follow the instructions to setup the frontend here: ./nsflow/frontend/README.md

    • On another terminal window

      cd nsflow/frontend; yarn install
      yarn dev
      
  • By default:

    • backend will be available at: http://127.0.0.1:8005
    • frontend will be available at: http://127.0.0.1:5173
    • You may change the host/port configs using environment variables for fastapi (refer run.py) and using frontend/.env.development for react app

Step 4

To make sure your changes to frontend take effect in the wheel, run the script

  • To build the Frontend

    sh build_scripts/build_frontend.sh
    

Note: The above script's output should show that ./nsflow dir contains a module prebuilt_frontend

  • To build and test the wheel locally

    sh build_scripts/build_wheel.sh
    

For using Text-to-Speech and Speech-to-Text

Prerequisite: install ffmpeg for text-to-speech and speech-to-text support

  • On Mac
brew install ffmpeg
  • On Linux
sudo apt install ffmpeg

Enabling Visual Question Answering (VQA) http endpoints

Follow these instructions


Connecting OAuth-protected MCP servers

Connect MCP servers that require OAuth (e.g. You.com, Linear, GitHub, Salesforce) from the Connectors tab — nsflow runs the OAuth flow, stores the tokens locally, and injects them into agent networks automatically. See these instructions.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nsflow-0.6.17.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nsflow-0.6.17-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file nsflow-0.6.17.tar.gz.

File metadata

  • Download URL: nsflow-0.6.17.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for nsflow-0.6.17.tar.gz
Algorithm Hash digest
SHA256 6c092a7fa60fe2cfe37683f8eb68cab3cde0063f547f374dc55532912d5b6ccf
MD5 19e0d530e232989c6239666b5023a497
BLAKE2b-256 526ec990360f8613255bc583953650c05ecd9ac4d79022d8f1a78f274641cc3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for nsflow-0.6.17.tar.gz:

Publisher: publish.yml on cognizant-ai-lab/nsflow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nsflow-0.6.17-py3-none-any.whl.

File metadata

  • Download URL: nsflow-0.6.17-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for nsflow-0.6.17-py3-none-any.whl
Algorithm Hash digest
SHA256 0f78baf6872cfcc01fce1c428659712fc94b2acae386976fe10299d0207da562
MD5 2aa0470be26091ceda6ed11e33175122
BLAKE2b-256 52c35fc8d576412c5a8d1a065749b3657966e9f577ea2054f69f917aaeff7700

See more details on using hashes here.

Provenance

The following attestation bundles were made for nsflow-0.6.17-py3-none-any.whl:

Publisher: publish.yml on cognizant-ai-lab/nsflow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.7.0

2 files

0.6.20

2 files

0.6.19

2 files

0.6.18

2 files

This release

0.6.17 This release

2 files

0.6.16

2 files

0.6.15

2 files

0.6.14

2 files

0.6.13

2 files

0.6.12

2 files

0.6.11

2 files

0.6.10

2 files

0.6.9

2 files

0.6.8

2 files

0.6.7

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.20

2 files

0.5.19

2 files

0.5.18

2 files

0.5.17

2 files

0.5.16

2 files

0.5.15

2 files

0.5.14

2 files

0.5.13

2 files

0.5.12

2 files

0.5.11

2 files

0.5.10

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page