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

Publishing

Release Drafts

Pending releases are curated by release-drafter/release-drafter on the Releases page.

Maintainers can see the next Draft release, regenerated every time release-drafter.yml is triggered.

PR Labeling

PRs merged since the last release are considered, with the labels on those PRs used for release metadata. feature, bug, chore, and dependencies are used for categorization, major, minor, and patch are used to influence the next release's version.

These labels can be altered after merge, re-trigger release-drafter to get it to regenerate the draft once you've curated the next release.

Triggering release

The tag version is used to set the version during the build, the value in pyproject.toml is not expected to be kept up-to-date.

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.10.0.tar.gz (39.0 kB view details)

Uploaded Source

Built Distribution

replit_river-0.10.0-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: replit_river-0.10.0.tar.gz
  • Upload date:
  • Size: 39.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.2

File hashes

Hashes for replit_river-0.10.0.tar.gz
Algorithm Hash digest
SHA256 d994814f13eb9cf21d3954d849d6c2bc82f53c6896b06c3875f61e62548ad0bb
MD5 ab9068ccfc39b30c9550807331a5a7d0
BLAKE2b-256 458c8f3eb378664d6c7c92db54d13c8ad3fe36cf1dc73b8426195442c0a739d3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for replit_river-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ee305d83683df7ec2387cbcb9572d4b6da98fe67f5bf2592a2e5e08f5dbc640
MD5 b9f132da4ca894661ea5177cffa9a4bc
BLAKE2b-256 1b1d6203efd4ce671e1a2255f26ddaec01eb15a9061daebc0e0fc6e0b9cbb434

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