Skip to content

Commit

Permalink
Update setup.py + readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xmival00 committed Nov 22, 2024
1 parent d1a7cdf commit 906c94d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
21 changes: 21 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
![Python](https://img.shields.io/badge/python-3.9-blue)
![Platform](https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey)

# BrainMaze: ZMQ

`brainmaze-zmq` provides utility functions and tools for working with ZeroMQ, enabling efficient multiprocess communication. This library is designed to be lightweight, modular, and multiplatform.

## Features

- Easy-to-use utilities for setting up ZeroMQ sockets (PUSH, PULL, PUB, SUB, REQ, REP).
- Support for scalable multiprocess communication.
- Compatible with Python 3.9 and above.
- Tested on Windows, macOS, and Linux.

## Installation

You can install the package via `pip`:

```bash
pip install brainmaze-zmq

5 changes: 4 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,13 @@
include_package_data=True,
classifiers=[
# https://pypi.python.org/pypi?%3Aaction=list_classifiers
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Programming Language :: Python :: Implementation :: CPython',
'Operating System :: Microsoft :: Windows'
'Operating System :: OS Independent'
],

)

0 comments on commit 906c94d

Please sign in to comment.