small-websocket-prebuilt 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- small_websocket_prebuilt-0.1.0/MANIFEST.in +1 -0
- small_websocket_prebuilt-0.1.0/PKG-INFO +72 -0
- small_websocket_prebuilt-0.1.0/README.md +55 -0
- small_websocket_prebuilt-0.1.0/pyproject.toml +40 -0
- small_websocket_prebuilt-0.1.0/setup.cfg +4 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/__init__.py +0 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/geist-cyrillic-wght-normal-CHSlOQsW.woff2 +0 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/geist-latin-ext-wght-normal-DMtmJ5ZE.woff2 +0 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/geist-latin-wght-normal-Dm3htQBi.woff2 +0 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/geist-mono-cyrillic-wght-normal-BZdD_g9V.woff2 +0 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/geist-mono-latin-ext-wght-normal-b6lpi8_2.woff2 +0 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/geist-mono-latin-wght-normal-Cjtb1TV-.woff2 +0 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/index-DGVmwdFu.js +390 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/index-MrVEiU1O.css +1 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/voice-ui-kit_false-BPs6efg0.js +1 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/assets/voice-ui-kit_false-b2I56sea.js +1 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/favicon.svg +8 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/hollycrm-logo.svg +23 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/index.html +17 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/client/dist/pipecat-logo.svg +7 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt/frontend.py +29 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt.egg-info/PKG-INFO +72 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt.egg-info/SOURCES.txt +24 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt.egg-info/dependency_links.txt +1 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt.egg-info/requires.txt +1 -0
- small_websocket_prebuilt-0.1.0/small_websocket_prebuilt.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
recursive-include pipecat_ai_small_websocket_prebuilt/client/dist *
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: small-websocket-prebuilt
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A simple, ready-to-use client for testing the WebSocket transport with Pipecat.
|
|
5
|
+
License: BSD 2-Clause License
|
|
6
|
+
Project-URL: homepage, https://github.com/Qiliang/small-websocket-prebuilt
|
|
7
|
+
Project-URL: source, https://github.com/Qiliang/small-websocket-prebuilt
|
|
8
|
+
Project-URL: issues, https://github.com/Qiliang/small-websocket-prebuilt/issues
|
|
9
|
+
Keywords: websocket,pipecat,voice,ai
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Topic :: Communications
|
|
13
|
+
Classifier: Topic :: Multimedia :: Sound/Audio
|
|
14
|
+
Requires-Python: >=3.10
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
Requires-Dist: fastapi[all]
|
|
17
|
+
|
|
18
|
+
# SmallWebSocket Prebuilt
|
|
19
|
+
|
|
20
|
+
A simple, ready-to-use client for testing the **WebSocketTransport** with [Pipecat](https://github.com/pipecat-ai/pipecat).
|
|
21
|
+
|
|
22
|
+
This prebuilt client provides basic WebSocket voice AI functionality and serves as a lightweight tool
|
|
23
|
+
to quickly verify transport behavior without needing a custom implementation.
|
|
24
|
+
|
|
25
|
+
Ideal for development, debugging, and quick prototyping.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 📦 Installation & Usage
|
|
30
|
+
|
|
31
|
+
If you just want to **use** the prebuilt WebSocket client in your own Python project:
|
|
32
|
+
|
|
33
|
+
### ✅ Install from PyPI
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pip install small-websocket-prebuilt
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### 🧰 Example Usage
|
|
40
|
+
|
|
41
|
+
```python
|
|
42
|
+
from fastapi import FastAPI
|
|
43
|
+
from fastapi.responses import RedirectResponse
|
|
44
|
+
from small_websocket_prebuilt.frontend import SmallWebSocketPrebuiltUI
|
|
45
|
+
|
|
46
|
+
app = FastAPI()
|
|
47
|
+
|
|
48
|
+
# Mount the frontend at /prebuilt
|
|
49
|
+
app.mount("/prebuilt", SmallWebSocketPrebuiltUI)
|
|
50
|
+
|
|
51
|
+
@app.get("/", include_in_schema=False)
|
|
52
|
+
async def root_redirect():
|
|
53
|
+
return RedirectResponse(url="/prebuilt/")
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## ⌨ Development Quick Start
|
|
57
|
+
|
|
58
|
+
If you want to work on the prebuilt client itself or use it locally in development:
|
|
59
|
+
|
|
60
|
+
#### 📋 Prerequisites
|
|
61
|
+
|
|
62
|
+
- [Node.js](https://nodejs.org/) (for building the client)
|
|
63
|
+
- [uv](https://docs.astral.sh/uv/) (recommended for Python dependency management)
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
## 🔗 WebSocket Transport
|
|
67
|
+
|
|
68
|
+
The client uses [`@pipecat-ai/websocket-transport`](https://github.com/pipecat-ai/pipecat-client-web-transports/tree/main/transports/websocket-transport) to connect to your Pipecat bot.
|
|
69
|
+
|
|
70
|
+
You can connect either:
|
|
71
|
+
- **Directly** using a WebSocket URL: `ws://localhost:7860/ws`
|
|
72
|
+
- **Via endpoint**: provide an HTTP URL that returns the WebSocket connection info
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# SmallWebSocket Prebuilt
|
|
2
|
+
|
|
3
|
+
A simple, ready-to-use client for testing the **WebSocketTransport** with [Pipecat](https://github.com/pipecat-ai/pipecat).
|
|
4
|
+
|
|
5
|
+
This prebuilt client provides basic WebSocket voice AI functionality and serves as a lightweight tool
|
|
6
|
+
to quickly verify transport behavior without needing a custom implementation.
|
|
7
|
+
|
|
8
|
+
Ideal for development, debugging, and quick prototyping.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## 📦 Installation & Usage
|
|
13
|
+
|
|
14
|
+
If you just want to **use** the prebuilt WebSocket client in your own Python project:
|
|
15
|
+
|
|
16
|
+
### ✅ Install from PyPI
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pip install small-websocket-prebuilt
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### 🧰 Example Usage
|
|
23
|
+
|
|
24
|
+
```python
|
|
25
|
+
from fastapi import FastAPI
|
|
26
|
+
from fastapi.responses import RedirectResponse
|
|
27
|
+
from small_websocket_prebuilt.frontend import SmallWebSocketPrebuiltUI
|
|
28
|
+
|
|
29
|
+
app = FastAPI()
|
|
30
|
+
|
|
31
|
+
# Mount the frontend at /prebuilt
|
|
32
|
+
app.mount("/prebuilt", SmallWebSocketPrebuiltUI)
|
|
33
|
+
|
|
34
|
+
@app.get("/", include_in_schema=False)
|
|
35
|
+
async def root_redirect():
|
|
36
|
+
return RedirectResponse(url="/prebuilt/")
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## ⌨ Development Quick Start
|
|
40
|
+
|
|
41
|
+
If you want to work on the prebuilt client itself or use it locally in development:
|
|
42
|
+
|
|
43
|
+
#### 📋 Prerequisites
|
|
44
|
+
|
|
45
|
+
- [Node.js](https://nodejs.org/) (for building the client)
|
|
46
|
+
- [uv](https://docs.astral.sh/uv/) (recommended for Python dependency management)
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## 🔗 WebSocket Transport
|
|
50
|
+
|
|
51
|
+
The client uses [`@pipecat-ai/websocket-transport`](https://github.com/pipecat-ai/pipecat-client-web-transports/tree/main/transports/websocket-transport) to connect to your Pipecat bot.
|
|
52
|
+
|
|
53
|
+
You can connect either:
|
|
54
|
+
- **Directly** using a WebSocket URL: `ws://localhost:7860/ws`
|
|
55
|
+
- **Via endpoint**: provide an HTTP URL that returns the WebSocket connection info
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=64"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "small-websocket-prebuilt"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "A simple, ready-to-use client for testing the WebSocket transport with Pipecat."
|
|
9
|
+
license = { text = "BSD 2-Clause License" }
|
|
10
|
+
readme = "README.md"
|
|
11
|
+
requires-python = ">=3.10"
|
|
12
|
+
keywords = ["websocket", "pipecat", "voice", "ai"]
|
|
13
|
+
classifiers = [
|
|
14
|
+
"Development Status :: 3 - Alpha",
|
|
15
|
+
"Intended Audience :: Developers",
|
|
16
|
+
"Topic :: Communications",
|
|
17
|
+
"Topic :: Multimedia :: Sound/Audio",
|
|
18
|
+
]
|
|
19
|
+
|
|
20
|
+
dependencies = [
|
|
21
|
+
"fastapi[all]",
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[dependency-groups]
|
|
25
|
+
dev = [
|
|
26
|
+
"setuptools~=78.1.1",
|
|
27
|
+
"build~=1.2.2",
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
[project.urls]
|
|
31
|
+
homepage = "https://github.com/Qiliang/small-websocket-prebuilt"
|
|
32
|
+
source = "https://github.com/Qiliang/small-websocket-prebuilt"
|
|
33
|
+
issues = "https://github.com/Qiliang/small-websocket-prebuilt/issues"
|
|
34
|
+
|
|
35
|
+
[tool.setuptools.packages.find]
|
|
36
|
+
where = ["."]
|
|
37
|
+
include = ["small_websocket_prebuilt*"]
|
|
38
|
+
|
|
39
|
+
[tool.setuptools.package-data]
|
|
40
|
+
"small_websocket_prebuilt" = ["client/dist/**/*"]
|
|
File without changes
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|