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

Make sure you have pypi token setup, easiest way is to set env var POETRY_PYPI_TOKEN_PYPI.

  • update version either manually or via poetry version
  • poetry build
  • poetry publish

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

Uploaded Source

Built Distribution

replit_river-0.2.19-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: replit_river-0.2.19.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Linux/6.5.0-1023-gcp

File hashes

Hashes for replit_river-0.2.19.tar.gz
Algorithm Hash digest
SHA256 8d432c351a09474aeaae2dfceb8075d3c7d9a783a415f6f880d557613e2af650
MD5 abc022b62389c9b5fa7f9210d683f39b
BLAKE2b-256 93b65c6c89de1e2a6d86ff32cf122f90c279726c0367ef2ef90c53935a66252c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: replit_river-0.2.19-py3-none-any.whl
  • Upload date:
  • Size: 37.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Linux/6.5.0-1023-gcp

File hashes

Hashes for replit_river-0.2.19-py3-none-any.whl
Algorithm Hash digest
SHA256 0f453cd1592f08b48d3321766bf0ae39d1d9c61859d41cdd1ecda91a9443bbc6
MD5 1b0d2076385d61905c1678bf440260f9
BLAKE2b-256 864d6f00a969a84ad1c12b851ff43fed812f2532a8ab58f249a6448de759c00f

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