Skip to content

Commit b0f4935

Browse files
prezaeiPedram Rezaei
andauthored
Document Python package on PyPI (#67)
Co-authored-by: Pedram Rezaei <pedram@lab.tailb6364e.ts.net>
1 parent 78a2ac9 commit b0f4935

7 files changed

Lines changed: 14 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
[![NuGet](https://img.shields.io/nuget/v/Cloudtoid.Interprocess?label=NuGet)](https://www.nuget.org/packages/Cloudtoid.Interprocess)
88
[![Rust](https://img.shields.io/crates/v/cloudtoid-interprocess?label=Rust)](https://crates.io/crates/cloudtoid-interprocess)
9+
[![PyPI](https://img.shields.io/pypi/v/cloudtoid-interprocess?label=PyPI)](https://pypi.org/project/cloudtoid-interprocess/)
910
[![C FFI](https://img.shields.io/crates/v/cloudtoid-interprocess-ffi?label=C%20FFI)](https://crates.io/crates/cloudtoid-interprocess-ffi)
1011
[![npm](https://img.shields.io/npm/v/@cloudtoid/interprocess?label=npm)](https://www.npmjs.com/package/@cloudtoid/interprocess)
1112
[![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.
2728

2829
## Languages
2930

30-
.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.
31+
.NET, Rust, Node.js, Go, Python, and the C SDK are released and available to install.
3132

3233
| Language | Package | Setup and API guide |
3334
| --- | --- | --- |
3435
| Rust | [`cloudtoid-interprocess`](https://crates.io/crates/cloudtoid-interprocess) (Cargo) | [Rust core](https://cloudtoid.com/docs/rust/) |
3536
| 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/) |
36-
| Python | Source build (PyPI pending); import `cloudtoid_interprocess` | [Python 3.9+](https://cloudtoid.com/docs/python/) |
37+
| Python | [`cloudtoid-interprocess`](https://pypi.org/project/cloudtoid-interprocess/) (PyPI) | [Python 3.9+](https://cloudtoid.com/docs/python/) |
3738
| Node.js | [`@cloudtoid/interprocess`](https://www.npmjs.com/package/@cloudtoid/interprocess) (npm) | [Node.js 18+, JavaScript and TypeScript](https://cloudtoid.com/docs/node/) |
3839
| 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/) |
3940
| .NET | [`Cloudtoid.Interprocess`][NuGet] (NuGet) | [.NET 10+, C# and dependency injection](https://cloudtoid.com/docs/dotnet/) |

‎src/python/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Fast shared-memory byte queues. Exchange messages directly with Rust, C, Go, Nod
66

77
## [Install](https://cloudtoid.com/docs/python/#install)
88

9-
PyPI publishing is pending. Run in an activated Python 3.9+ virtual environment with Git, Rust, and a native linker installed.
9+
Requires Python 3.9 or later.
1010

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

1515
## Example

‎src/website/docs/overview.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ <h2 id="choose-language">Choose your language</h2>
55
<a href="/docs/node/"><strong>Node.js &amp; TypeScript</strong><span>Buffers, promises, and AbortSignal.</span><code>npm install @cloudtoid/interprocess</code></a>
66
<a href="/docs/go/"><strong>Go</strong><span>Byte slices, context cancellation, and cgo.</span><code>go get github.com/cloudtoid/interprocess/src/go/v3@latest</code></a>
77
<a href="/docs/c/"><strong>C</strong><span>A small ABI with explicit buffer ownership.</span><code>#include &lt;interprocess.h&gt;</code></a>
8-
<a href="/docs/python/"><strong>Python</strong><span>Bytes, timeouts, and context managers. Build from source.</span><code>from cloudtoid_interprocess import Publisher</code></a>
8+
<a href="/docs/python/"><strong>Python</strong><span>Bytes, timeouts, and context managers.</span><code>python -m pip install cloudtoid-interprocess</code></a>
99
<a href="/docs/dotnet/"><strong>.NET</strong><span>Spans, reusable memory, and CancellationToken.</span><code>dotnet add package Cloudtoid.Interprocess</code></a>
1010
</div>
1111
<h2 id="first-queue">Your first queue</h2>

‎src/website/docs/pages.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
"slug": "python",
5252
"label": "Python",
5353
"title": "Python shared-memory IPC: installation and API",
54-
"description": "Build Cloudtoid Interprocess for Python. Send bytes and buffer objects, receive with timeouts, use context managers, and handle queue exceptions."
54+
"description": "Install Cloudtoid Interprocess from PyPI. Send bytes and buffer objects, receive with timeouts, use context managers, and handle queue exceptions."
5555
},
5656
{
5757
"slug": "dotnet",

‎src/website/docs/python-rust.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ <h2 id="setup">Install and prepare</h2>
99
<pre><code class="language-bash">source .venv/bin/activate</code></pre>
1010
<p>Windows PowerShell:</p>
1111
<pre><code class="language-powershell">.venv\Scripts\Activate.ps1</code></pre>
12-
<p>Use <code>python3</code> instead of <code>python</code> if that is how your system names Python 3. The Python package currently builds from source; it is not yet on PyPI.</p>
13-
<pre><code class="language-bash">python -m pip install "git+https://github.com/cloudtoid/interprocess.git@native-v3.0.1#subdirectory=src/python"
12+
<p>Use <code>python3</code> instead of <code>python</code> if that is how your system names Python 3.</p>
13+
<pre><code class="language-bash">python -m pip install cloudtoid-interprocess
1414
cargo new sender
1515
cd sender
1616
cargo add cloudtoid-interprocess@3.0.1

‎src/website/docs/python.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<p class="doc-lead">Send Python bytes and buffer objects through the shared Rust engine. Use context managers to keep endpoint lifetimes explicit.</p>
22
<p class="doc-source"><a href="https://github.com/cloudtoid/interprocess/tree/main/src/python">Python package source ↗</a> · <a href="https://github.com/cloudtoid/interprocess/blob/main/src/python/src/lib.rs">Binding implementation ↗</a></p>
3-
<h2 id="install">Install from source</h2>
4-
<p>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:</p>
5-
<pre><code class="language-bash">python -m pip install "git+https://github.com/cloudtoid/interprocess.git@native-v3.0.1#subdirectory=src/python"</code></pre>
3+
<h2 id="install">Install</h2>
4+
<p>Requires Python 3.9 or later.</p>
5+
<pre><code class="language-bash">python -m pip install cloudtoid-interprocess</code></pre>
66
<p>Connecting different languages? Follow the <a href="/docs/python-rust/">Rust-to-Python messaging tutorial</a>.</p>
77
<h2 id="example">Send and receive</h2>
88
<pre><code class="language-python">from cloudtoid_interprocess import Publisher, Subscriber

‎src/website/site.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ const installation = {
1212
"dotnet add package Cloudtoid.Interprocess"
1313
],
1414
"Python": [
15-
"PyPI publishing is pending. Run in an activated Python 3.9+ virtual environment with Git, Rust, and a native linker installed.",
16-
"python -m pip install \"git+https://github.com/cloudtoid/interprocess.git@native-v3.0.1#subdirectory=src/python\""
15+
"Run in an activated Python 3.9+ virtual environment.",
16+
"python -m pip install cloudtoid-interprocess"
1717
],
1818
"Go": [
1919
"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.",

0 commit comments

Comments
 (0)