Metadata-Version: 2.4
Name: ipcs
Version: 0.2.2
Summary: Simple IPC server/client
Project-URL: Source, https://github.com/tasuren/ipcs
Project-URL: Documentation, https://ipcs.readthedocs.io/
Author-email: Takagi Tasuku <tasuren@outlook.jp>
License-Expression: MIT
License-File: LICENSE
Keywords: ipc,networking
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: orjson>=3.10
Requires-Dist: websockets>=16.0
Description-Content-Type: text/markdown

[![PyPI](https://img.shields.io/pypi/v/ipcs)](https://pypi.org/project/ipcs/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ipcs)
![PyPI - License](https://img.shields.io/pypi/l/ipcs)
[![Documentation Status](https://readthedocs.org/projects/ipcs/badge/?version=latest)](https://ipcs.readthedocs.io/en/latest/?badge=latest)

# ipcs

A library for Python for IPC.  
(Although it is written as IPC, it can also be used for communication with an external server.)

## ⚠️ Maintenance Status

This project is currently in maintenance mode.
I do not intend to add new features or perform non-critical updates.
Security-related issues will be addressed as needed.

## Installation

`$ pip install ipcs`

## Examples

Run `ipcs-server` and run following code.

### Client A

```python
# Client A

from ipcs import Client, Request

client = Client("a")

@client.route()
async def hello(request: Request, word: str):
    print("Hello, %s!" % word)

client.run("ws://localhost/", port=8080)
```

### Client B

```python
# Client B

from ipcs import Client

client = Client("b")

@client.listen()
async def on_ready():
    # Run client a's hello str to say greetings to world.
    await client.request("a", "hello", "World")
    # or `await client.connections.a.request("hello", "World")`

client.run("ws://localhost/", port=8080)
```

## License

The license is MIT and details can be found [here](https://github.com/tasuren/ipcs/blob/main/LICENSE).

## Documentation

Documentation is avaliable [here](https://ipcs.readthedocs.io/en/latest/).
