chore: rename quicproquo → quicprochat in docs, Docker, CI, and packaging
Rename all project references from quicproquo/qpq to quicprochat/qpc across documentation, Docker configuration, CI workflows, packaging scripts, operational configs, and build tooling. - Docker: crate paths, binary names, user/group, data dirs, env vars - CI: workflow crate references, binary names, artifact names - Docs: all markdown files under docs/, SDK READMEs, book.toml - Packaging: OpenWrt Makefile, init script, UCI config (file renames) - Scripts: justfile, dev-shell, screenshot, cross-compile, ai_team - Operations: Prometheus config, alert rules, Grafana dashboard - Config: .env.example (QPQ_* → QPC_*), CODEOWNERS paths - Top-level: README, CONTRIBUTING, ROADMAP, CLAUDE.md
This commit is contained in:
@@ -1,16 +1,16 @@
|
||||
# quicproquo Python SDK
|
||||
# quicprochat Python SDK
|
||||
|
||||
Python client library for the [quicproquo](https://github.com/nicholasgasior/quicproquo) E2E encrypted messenger.
|
||||
Python client library for the [quicprochat](https://github.com/nicholasgasior/quicprochat) E2E encrypted messenger.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Python 3.10+
|
||||
- A running quicproquo server
|
||||
- A running quicprochat server
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
pip install quicproquo
|
||||
pip install quicprochat
|
||||
```
|
||||
|
||||
For development:
|
||||
@@ -27,7 +27,7 @@ Uses [aioquic](https://github.com/aiortc/aioquic) for native QUIC transport with
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from quicproquo import QpqClient, ConnectOptions
|
||||
from quicprochat import QpqClient, ConnectOptions
|
||||
|
||||
async def main():
|
||||
client = await QpqClient.connect(ConnectOptions(
|
||||
@@ -61,15 +61,15 @@ asyncio.run(main())
|
||||
|
||||
### 2. Rust FFI (synchronous)
|
||||
|
||||
Wraps `libquicproquo_ffi` via CFFI for full Rust crypto stack (MLS, hybrid KEM, OPAQUE) at native speed.
|
||||
Wraps `libquicprochat_ffi` via CFFI for full Rust crypto stack (MLS, hybrid KEM, OPAQUE) at native speed.
|
||||
|
||||
```sh
|
||||
# Build the FFI library first
|
||||
cargo build --release -p quicproquo-ffi
|
||||
cargo build --release -p quicprochat-ffi
|
||||
```
|
||||
|
||||
```python
|
||||
from quicproquo import QpqClient, ConnectOptions
|
||||
from quicprochat import QpqClient, ConnectOptions
|
||||
|
||||
client = QpqClient.connect_ffi(ConnectOptions(
|
||||
addr="127.0.0.1:5001",
|
||||
@@ -138,7 +138,7 @@ client.close_sync()
|
||||
|
||||
## Wire Format
|
||||
|
||||
The SDK implements the qpq v2 wire format:
|
||||
The SDK implements the qpc v2 wire format:
|
||||
|
||||
```
|
||||
[method_id:u16][req_id:u32][len:u32][protobuf payload]
|
||||
@@ -148,12 +148,12 @@ Each RPC is sent over its own QUIC bidirectional stream.
|
||||
|
||||
## Structure
|
||||
|
||||
- `quicproquo/client.py` -- High-level client API
|
||||
- `quicproquo/transport.py` -- QUIC transport (aioquic)
|
||||
- `quicproquo/ffi.py` -- Rust FFI transport (CFFI)
|
||||
- `quicproquo/proto.py` -- Protobuf encode/decode (no codegen)
|
||||
- `quicproquo/wire.py` -- v2 wire format framing
|
||||
- `quicproquo/types.py` -- Data types and exceptions
|
||||
- `quicprochat/client.py` -- High-level client API
|
||||
- `quicprochat/transport.py` -- QUIC transport (aioquic)
|
||||
- `quicprochat/ffi.py` -- Rust FFI transport (CFFI)
|
||||
- `quicprochat/proto.py` -- Protobuf encode/decode (no codegen)
|
||||
- `quicprochat/wire.py` -- v2 wire format framing
|
||||
- `quicprochat/types.py` -- Data types and exceptions
|
||||
- `examples/bot.py` -- Async echo bot example
|
||||
- `examples/ffi_demo.py` -- Synchronous FFI example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user