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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: replit_river-0.12.0.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.0.tar.gz
Algorithm Hash digest
SHA256 82ac412509cb399cbb5ce41933b14ded6513ac354d579837b09528ac3b262687
MD5 0b0cd447ea3643789b967dd2209bcc1e
BLAKE2b-256 e733b1f87b98c5d2bc19b72fab3a0a13d378a89d7da36466dec64db1d04dcfc0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for replit_river-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c9703ad097c6938823b149eeaff949744c5ec58c4921feecd852b98883fec5ff
MD5 381b2478849566d6ad60d8f7ac8bf1f4
BLAKE2b-256 def5dd24056116d9c2053573a736cb7c0739c698785adb4b8bc202dae606be5a

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