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
Built Distribution
File details
Details for the file replit_river-0.6.0.tar.gz
.
File metadata
- Download URL: replit_river-0.6.0.tar.gz
- Upload date:
- Size: 33.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.5 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d08fa510c7bcb131f17bc4de9b20fe317e69e3c478072d704349dd6b8f3e6355 |
|
MD5 | dafa729125737aa417c21c325928b950 |
|
BLAKE2b-256 | 2625ff9409d7e8fed23010ea267f1bbda1fef2b51349b21d2e839603f86c1b58 |
File details
Details for the file replit_river-0.6.0-py3-none-any.whl
.
File metadata
- Download URL: replit_river-0.6.0-py3-none-any.whl
- Upload date:
- Size: 42.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.5 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56343067788463fb905854389ab694ab39791f605a0c07a5ad7da20a45ab83d3 |
|
MD5 | 1039c25fad5e5cbe219b766ee4594ebb |
|
BLAKE2b-256 | 672ad72ab02e33a78bd0a3d2997dff94f64bf7a8d32583da5ed11c1dcbf137ce |