Skip to main content

Replit river toolkit for Python

Project description

River

Machinery for compatibility with https://github.com/replit/river, the protocol behind the Workspace ↔ pid2 WebSocket (and in general, the protocol behind the Workspace ↔ * WebSocket).

Since the pid2 services are declared in TypeScript using TypeBox in the main repl-it-web repository, and it would be terrible for everyone involved to force folks to follow this paradigm of declaring their services, types, and interfaces in a foreign repository, any other River servers will use gRPC for their protocol definition and implementation. The @replit/river-codegen package can be used to compile the gRPC .proto files into a River-compatible TypeBox declaration that can be then packaged into an npm package that can be imported by the Workspace and consumed ergonomically.

This includes the necessary machinery to act as a client or server for River:

  • As a River server, create a WebSocket server and the gRPC -> Python River codegen (similar to the protoc flow that generates the Python bindings).
  • As a River client, create a WebSocket client and the JSON Schema -> Python River codegen. python -m river.codegen client --output pkgs/river/river/schema.py --client-name Pid2Client pkgs/river/schema.json
  • If we need to create the client-side of a Python gRPC River server, we also need to generate the JSON schema from the .proto file, with this command: python -m river.codegen server-schema --output pkgs/river/river/schema.py pkgs/river/tests/client/proto/test.proto && cat ./test_schema.json

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

replit_river-0.1.11.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

replit_river-0.1.11-py3-none-any.whl (35.1 kB view details)

Uploaded Python 3

File details

Details for the file replit_river-0.1.11.tar.gz.

File metadata

  • Download URL: replit_river-0.1.11.tar.gz
  • Upload date:
  • Size: 27.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Darwin/22.6.0

File hashes

Hashes for replit_river-0.1.11.tar.gz
Algorithm Hash digest
SHA256 c43a1e43cebbc3991f50795014c081ed1bedbc17cc4efb03a391dacaf62d85e5
MD5 7c273209293d7a955d3479955b6f8d78
BLAKE2b-256 da4af3eca71d411b62a56462d7fc836e4e4b23c34cec6ba37b3d11a681736282

See more details on using hashes here.

File details

Details for the file replit_river-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: replit_river-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 35.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Darwin/22.6.0

File hashes

Hashes for replit_river-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e81b15d109b800d47fb029a4102d323f84b7ea41e8119895bf36e2e27f6191e0
MD5 cba886d2a218c1fb9a839d5d9b8522ac
BLAKE2b-256 b7ae6143c455af9e3677fba1ea3ca8dc831be268ade838f0c84ada816e71629e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page