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

Uploaded Source

Built Distribution

replit_river-0.12.1-py3-none-any.whl (46.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for replit_river-0.12.1.tar.gz
Algorithm Hash digest
SHA256 32d246c12948396bf47708c9cb4db447516c7f64a3e8e25eb22301e04939ba8e
MD5 1b3f89f62c0e5a035e54d058042df6c1
BLAKE2b-256 3d5bce5b74b26803480598e8233a53551964c58d4bdc7c8d2b855d3a4e8cfd87

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for replit_river-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0943a185aa68205ecc33b1a5dc0a6b41fc96e2c363b21aff59248cba1924ca50
MD5 636716d4a1be5485755ae671fc1578ea
BLAKE2b-256 698b48bac01e249ba5aeae5b4c302a6a88e5ab5739cc02115a9db679cfdef40c

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