From 0a81c18699e2bf9fc122d6ba3c8a1dfab2bf7d21 Mon Sep 17 00:00:00 2001 From: Pedram Rezaei Date: Thu, 17 Sep 2026 22:24:54 -0700 Subject: [PATCH] Document Python package on PyPI --- README.md | 5 +++-- src/python/README.md | 4 ++-- src/website/docs/overview.html | 2 +- src/website/docs/pages.json | 2 +- src/website/docs/python-rust.html | 4 ++-- src/website/docs/python.html | 6 +++--- src/website/site.js | 4 ++-- 7 files changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c4c411f..64d3762 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![NuGet](https://img.shields.io/nuget/v/Cloudtoid.Interprocess?label=NuGet)](https://www.nuget.org/packages/Cloudtoid.Interprocess) [![Rust](https://img.shields.io/crates/v/cloudtoid-interprocess?label=Rust)](https://crates.io/crates/cloudtoid-interprocess) +[![PyPI](https://img.shields.io/pypi/v/cloudtoid-interprocess?label=PyPI)](https://pypi.org/project/cloudtoid-interprocess/) [![C FFI](https://img.shields.io/crates/v/cloudtoid-interprocess-ffi?label=C%20FFI)](https://crates.io/crates/cloudtoid-interprocess-ffi) [![npm](https://img.shields.io/npm/v/@cloudtoid/interprocess?label=npm)](https://www.npmjs.com/package/@cloudtoid/interprocess) [![Go](https://img.shields.io/github/v/tag/cloudtoid/interprocess?filter=src%2Fgo%2Fv*&label=Go)](https://pkg.go.dev/github.com/cloudtoid/interprocess/src/go/v3) @@ -27,13 +28,13 @@ Interprocess is used internally by Microsoft. ## Languages -.NET, Rust, Node.js, Go, and the C SDK are released and available to install. Python is available from source; publishing to PyPI is pending. +.NET, Rust, Node.js, Go, Python, and the C SDK are released and available to install. | Language | Package | Setup and API guide | | --- | --- | --- | | Rust | [`cloudtoid-interprocess`](https://crates.io/crates/cloudtoid-interprocess) (Cargo) | [Rust core](https://cloudtoid.com/docs/rust/) | | C / C++ | [C SDK](https://github.com/cloudtoid/interprocess/releases/latest); [`cloudtoid-interprocess-ffi`](https://crates.io/crates/cloudtoid-interprocess-ffi) (Cargo) | [C ABI, headers, and shared library](https://cloudtoid.com/docs/c/) | -| Python | Source build (PyPI pending); import `cloudtoid_interprocess` | [Python 3.9+](https://cloudtoid.com/docs/python/) | +| Python | [`cloudtoid-interprocess`](https://pypi.org/project/cloudtoid-interprocess/) (PyPI) | [Python 3.9+](https://cloudtoid.com/docs/python/) | | Node.js | [`@cloudtoid/interprocess`](https://www.npmjs.com/package/@cloudtoid/interprocess) (npm) | [Node.js 18+, JavaScript and TypeScript](https://cloudtoid.com/docs/node/) | | Go | [`github.com/cloudtoid/interprocess/src/go/v3`](https://pkg.go.dev/github.com/cloudtoid/interprocess/src/go/v3) | [Go 1.24+, cgo, and the C SDK](https://cloudtoid.com/docs/go/) | | .NET | [`Cloudtoid.Interprocess`][NuGet] (NuGet) | [.NET 10+, C# and dependency injection](https://cloudtoid.com/docs/dotnet/) | diff --git a/src/python/README.md b/src/python/README.md index e9d1abb..51d7dfe 100644 --- a/src/python/README.md +++ b/src/python/README.md @@ -6,10 +6,10 @@ Fast shared-memory byte queues. Exchange messages directly with Rust, C, Go, Nod ## [Install](https://cloudtoid.com/docs/python/#install) -PyPI publishing is pending. Run in an activated Python 3.9+ virtual environment with Git, Rust, and a native linker installed. +Requires Python 3.9 or later. ```sh -python -m pip install "git+https://github.com/cloudtoid/interprocess.git@native-v3.0.1#subdirectory=src/python" +python -m pip install cloudtoid-interprocess ``` ## Example diff --git a/src/website/docs/overview.html b/src/website/docs/overview.html index ca91889..a529bdc 100644 --- a/src/website/docs/overview.html +++ b/src/website/docs/overview.html @@ -5,7 +5,7 @@

Choose your language

Node.js & TypeScriptBuffers, promises, and AbortSignal.npm install @cloudtoid/interprocess GoByte slices, context cancellation, and cgo.go get github.com/cloudtoid/interprocess/src/go/v3@latest CA small ABI with explicit buffer ownership.#include <interprocess.h> -PythonBytes, timeouts, and context managers. Build from source.from cloudtoid_interprocess import Publisher +PythonBytes, timeouts, and context managers.python -m pip install cloudtoid-interprocess .NETSpans, reusable memory, and CancellationToken.dotnet add package Cloudtoid.Interprocess

Your first queue

diff --git a/src/website/docs/pages.json b/src/website/docs/pages.json index 07a37b3..72d1751 100644 --- a/src/website/docs/pages.json +++ b/src/website/docs/pages.json @@ -51,7 +51,7 @@ "slug": "python", "label": "Python", "title": "Python shared-memory IPC: installation and API", - "description": "Build Cloudtoid Interprocess for Python. Send bytes and buffer objects, receive with timeouts, use context managers, and handle queue exceptions." + "description": "Install Cloudtoid Interprocess from PyPI. Send bytes and buffer objects, receive with timeouts, use context managers, and handle queue exceptions." }, { "slug": "dotnet", diff --git a/src/website/docs/python-rust.html b/src/website/docs/python-rust.html index 1572182..d3a59ef 100644 --- a/src/website/docs/python-rust.html +++ b/src/website/docs/python-rust.html @@ -9,8 +9,8 @@

Install and prepare

source .venv/bin/activate

Windows PowerShell:

.venv\Scripts\Activate.ps1
-

Use python3 instead of python if that is how your system names Python 3. The Python package currently builds from source; it is not yet on PyPI.

-
python -m pip install "git+https://github.com/cloudtoid/interprocess.git@native-v3.0.1#subdirectory=src/python"
+
Use python3 instead of python if that is how your system names Python 3.

+
python -m pip install cloudtoid-interprocess
 cargo new sender
 cd sender
 cargo add cloudtoid-interprocess@3.0.1
diff --git a/src/website/docs/python.html b/src/website/docs/python.html
index 428db3c..e8e3305 100644
--- a/src/website/docs/python.html
+++ b/src/website/docs/python.html
@@ -1,8 +1,8 @@
 
Send Python bytes and buffer objects through the shared Rust engine. Use context managers to keep endpoint lifetimes explicit.

 
Python package source ↗ · Binding implementation ↗

-
Install from source

-
The Python package is not yet published on PyPI. Requires Python 3.9 or later, Git, Rust, and a native linker. Run in an activated virtual environment:

-
python -m pip install "git+https://github.com/cloudtoid/interprocess.git@native-v3.0.1#subdirectory=src/python"

+
Install

+
Requires Python 3.9 or later.

+
python -m pip install cloudtoid-interprocess

 
Connecting different languages? Follow the Rust-to-Python messaging tutorial.

 
Send and receive

 
from cloudtoid_interprocess import Publisher, Subscriber
diff --git a/src/website/site.js b/src/website/site.js
index fda2f89..27a2efc 100644
--- a/src/website/site.js
+++ b/src/website/site.js
@@ -12,8 +12,8 @@ const installation = {
     "dotnet add package Cloudtoid.Interprocess"
   ],
   "Python": [
-    "PyPI publishing is pending. Run in an activated Python 3.9+ virtual environment with Git, Rust, and a native linker installed.",
-    "python -m pip install \"git+https://github.com/cloudtoid/interprocess.git@native-v3.0.1#subdirectory=src/python\""
+    "Run in an activated Python 3.9+ virtual environment.",
+    "python -m pip install cloudtoid-interprocess"
   ],
   "Go": [
     "Install the C SDK first (see the C guide), then run in your Go module. Requires Go 1.24+, cgo enabled, a C compiler, and pkg-config.",