markethub-ddn 1.0.0__tar.gz

markethub_ddn-1.0.0/.gitignore

@@ -0,0 +1,94 @@
+.idea
+.ruff_cache
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+.venv/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject

markethub_ddn-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Centrifugal Labs LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

markethub_ddn-1.0.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: markethub-ddn
+Version: 1.0.0
+Summary: MarketHub DDN - WebSocket SDK for Centrifugo with built-in offset persistence and automatic recovery
+Author: MarketHub
+License-Expression: MIT
+License-File: LICENSE
+Keywords: Centrifugo,DDN,MarketHub,Offset Persistence,Pub/Sub,Realtime,Streaming,WebSocket
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: protobuf<7.0.0,>=4.23.4
+Requires-Dist: websockets<16.0.0,>=14.0.0
+Provides-Extra: dev
+Requires-Dist: pre-commit~=3.5.0; extra == 'dev'
+Requires-Dist: ruff~=0.1.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# centrifuge-python
+
+[![CI](https://github.com/centrifugal/centrifuge-python/actions/workflows/test.yml/badge.svg)](https://github.com/centrifugal/centrifuge-python/actions/workflows/test.yml?query=event%3Apush+branch%3Amaster+workflow%3ATest)
+[![pypi](https://img.shields.io/pypi/v/centrifuge-python.svg)](https://pypi.python.org/pypi/centrifuge-python)
+[![versions](https://img.shields.io/pypi/pyversions/centrifuge-python.svg)](https://github.com/centrifugal/centrifuge-python)
+[![license](https://img.shields.io/github/license/centrifugal/centrifuge-python.svg)](https://github.com/centrifugal/centrifuge-python/blob/master/LICENSE)
+
+This is a WebSocket real-time SDK for [Centrifugo](https://github.com/centrifugal/centrifugo) server (and any [Centrifuge-based](https://github.com/centrifugal/centrifuge) server) on top of Python asyncio library.
+
+> [!TIP]
+> If you are looking for Centrifugo [server API](https://centrifugal.dev/docs/server/server_api) client – check out [pycent](https://github.com/centrifugal/pycent) instead.
+
+Before starting to work with this library check out Centrifugo [client SDK API specification](https://centrifugal.dev/docs/transports/client_api) as it contains common information about Centrifugal real-time SDK behavior. This SDK supports all major features of Centrifugo client protocol - see [SDK feature matrix](https://centrifugal.dev/docs/transports/client_sdk#sdk-feature-matrix).
+
+## Install
+
+```
+pip install centrifuge-python
+```
+
+Then in your code:
+
+```
+from centrifuge import Client
+```
+
+See [example code](https://github.com/centrifugal/centrifuge-python/blob/master/example.py) and [how to run it](#run-example) locally.
+
+## JSON vs Protobuf protocols
+
+By default, SDK uses JSON protocol. If you want to use Protobuf protocol instead then pass `use_protobuf=True` option to `Client` constructor.
+
+When using JSON protocol:
+
+* all payloads (data to publish, connect/subscribe data) you pass to the library are encoded to JSON internally using `json.dumps` before sending to server. So make sure you pass only JSON-serializable data to the library.
+* all payloads received from server are decoded to Python objects using `json.loads` internally before passing to your code.
+
+When using Protobuf protocol:
+
+* all payloads you pass to the library must be `bytes` or `None` if optional. If you pass non-`bytes` data – exception will be raised.
+* all payloads received from the library will be `bytes` or `None` if not present.
+* don't forget that when using Protobuf protocol you can still have JSON payloads - just encode them to `bytes` before passing to the library.
+
+## Callbacks should not block
+
+Event callbacks are called by SDK using `await` internally, the websocket connection read loop is blocked for the time SDK waits for the callback to be executed. This means that if you need to perform long operations in callbacks consider moving the work to a separate coroutine/task to return fast and continue reading data from the websocket.
+
+The fact WebSocket read is blocked for the time we execute callbacks means that you can not call awaitable SDK APIs from callback – because SDK does not have a chance to read the reply. You will get `OperationTimeoutError` exception. The rule is the same - do the work asynchronously, for example use `asyncio.ensure_future`.
+
+## Run example
+
+To run [example](https://github.com/centrifugal/centrifuge-python/blob/master/example.py), first start Centrifugo with config like this:
+
+```json
+{
+  "client": {
+    "token": {
+      "hmac_secret_key": "secret"
+    }
+  },
+  "channel": {
+    "namespaces": [
+      {
+        "name": "example",
+        "presence": true,
+        "history_size": 300,
+        "history_ttl": "300s",
+        "join_leave": true,
+        "force_push_join_leave": true,
+        "allow_publish_for_subscriber": true,
+        "allow_presence_for_subscriber": true,
+        "allow_history_for_subscriber": true
+      }
+    ]
+  }
+}
+```
+
+And then:
+
+```bash
+python -m venv env
+. env/bin/activate
+make dev
+python example.py
+```
+
+## Run tests
+
+To run tests, first start Centrifugo server:
+
+```bash
+docker pull centrifugo/centrifugo:v6
+docker run -d -p 8000:8000 \
+-e CENTRIFUGO_CLIENT_TOKEN_HMAC_SECRET_KEY="secret" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_ALLOWED_DELTA_TYPES="fossil" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_DELTA_PUBLISH="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_PRESENCE="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_JOIN_LEAVE="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_FORCE_PUSH_JOIN_LEAVE="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_HISTORY_SIZE="100" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_HISTORY_TTL="300s" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_FORCE_RECOVERY="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_ALLOW_PUBLISH_FOR_SUBSCRIBER="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_ALLOW_PRESENCE_FOR_SUBSCRIBER="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_ALLOW_HISTORY_FOR_SUBSCRIBER="true" \
+-e CENTRIFUGO_CLIENT_SUBSCRIBE_TO_USER_PERSONAL_CHANNEL_ENABLED="true" \
+-e CENTRIFUGO_LOG_LEVEL="trace" \
+centrifugo/centrifugo:v6 centrifugo
+```
+
+And then (from cloned repo root):
+
+```bash
+python -m venv env
+. env/bin/activate
+make dev
+make test
+```

markethub_ddn-1.0.0/README.md

@@ -0,0 +1,119 @@
+# centrifuge-python
+
+[![CI](https://github.com/centrifugal/centrifuge-python/actions/workflows/test.yml/badge.svg)](https://github.com/centrifugal/centrifuge-python/actions/workflows/test.yml?query=event%3Apush+branch%3Amaster+workflow%3ATest)
+[![pypi](https://img.shields.io/pypi/v/centrifuge-python.svg)](https://pypi.python.org/pypi/centrifuge-python)
+[![versions](https://img.shields.io/pypi/pyversions/centrifuge-python.svg)](https://github.com/centrifugal/centrifuge-python)
+[![license](https://img.shields.io/github/license/centrifugal/centrifuge-python.svg)](https://github.com/centrifugal/centrifuge-python/blob/master/LICENSE)
+
+This is a WebSocket real-time SDK for [Centrifugo](https://github.com/centrifugal/centrifugo) server (and any [Centrifuge-based](https://github.com/centrifugal/centrifuge) server) on top of Python asyncio library.
+
+> [!TIP]
+> If you are looking for Centrifugo [server API](https://centrifugal.dev/docs/server/server_api) client – check out [pycent](https://github.com/centrifugal/pycent) instead.
+
+Before starting to work with this library check out Centrifugo [client SDK API specification](https://centrifugal.dev/docs/transports/client_api) as it contains common information about Centrifugal real-time SDK behavior. This SDK supports all major features of Centrifugo client protocol - see [SDK feature matrix](https://centrifugal.dev/docs/transports/client_sdk#sdk-feature-matrix).
+
+## Install
+
+```
+pip install centrifuge-python
+```
+
+Then in your code:
+
+```
+from centrifuge import Client
+```
+
+See [example code](https://github.com/centrifugal/centrifuge-python/blob/master/example.py) and [how to run it](#run-example) locally.
+
+## JSON vs Protobuf protocols
+
+By default, SDK uses JSON protocol. If you want to use Protobuf protocol instead then pass `use_protobuf=True` option to `Client` constructor.
+
+When using JSON protocol:
+
+* all payloads (data to publish, connect/subscribe data) you pass to the library are encoded to JSON internally using `json.dumps` before sending to server. So make sure you pass only JSON-serializable data to the library.
+* all payloads received from server are decoded to Python objects using `json.loads` internally before passing to your code.
+
+When using Protobuf protocol:
+
+* all payloads you pass to the library must be `bytes` or `None` if optional. If you pass non-`bytes` data – exception will be raised.
+* all payloads received from the library will be `bytes` or `None` if not present.
+* don't forget that when using Protobuf protocol you can still have JSON payloads - just encode them to `bytes` before passing to the library.
+
+## Callbacks should not block
+
+Event callbacks are called by SDK using `await` internally, the websocket connection read loop is blocked for the time SDK waits for the callback to be executed. This means that if you need to perform long operations in callbacks consider moving the work to a separate coroutine/task to return fast and continue reading data from the websocket.
+
+The fact WebSocket read is blocked for the time we execute callbacks means that you can not call awaitable SDK APIs from callback – because SDK does not have a chance to read the reply. You will get `OperationTimeoutError` exception. The rule is the same - do the work asynchronously, for example use `asyncio.ensure_future`.
+
+## Run example
+
+To run [example](https://github.com/centrifugal/centrifuge-python/blob/master/example.py), first start Centrifugo with config like this:
+
+```json
+{
+  "client": {
+    "token": {
+      "hmac_secret_key": "secret"
+    }
+  },
+  "channel": {
+    "namespaces": [
+      {
+        "name": "example",
+        "presence": true,
+        "history_size": 300,
+        "history_ttl": "300s",
+        "join_leave": true,
+        "force_push_join_leave": true,
+        "allow_publish_for_subscriber": true,
+        "allow_presence_for_subscriber": true,
+        "allow_history_for_subscriber": true
+      }
+    ]
+  }
+}
+```
+
+And then:
+
+```bash
+python -m venv env
+. env/bin/activate
+make dev
+python example.py
+```
+
+## Run tests
+
+To run tests, first start Centrifugo server:
+
+```bash
+docker pull centrifugo/centrifugo:v6
+docker run -d -p 8000:8000 \
+-e CENTRIFUGO_CLIENT_TOKEN_HMAC_SECRET_KEY="secret" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_ALLOWED_DELTA_TYPES="fossil" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_DELTA_PUBLISH="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_PRESENCE="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_JOIN_LEAVE="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_FORCE_PUSH_JOIN_LEAVE="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_HISTORY_SIZE="100" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_HISTORY_TTL="300s" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_FORCE_RECOVERY="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_ALLOW_PUBLISH_FOR_SUBSCRIBER="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_ALLOW_PRESENCE_FOR_SUBSCRIBER="true" \
+-e CENTRIFUGO_CHANNEL_WITHOUT_NAMESPACE_ALLOW_HISTORY_FOR_SUBSCRIBER="true" \
+-e CENTRIFUGO_CLIENT_SUBSCRIBE_TO_USER_PERSONAL_CHANNEL_ENABLED="true" \
+-e CENTRIFUGO_LOG_LEVEL="trace" \
+centrifugo/centrifugo:v6 centrifugo
+```
+
+And then (from cloned repo root):
+
+```bash
+python -m venv env
+. env/bin/activate
+make dev
+make test
+```

markethub_ddn-1.0.0/centrifuge/__init__.py

@@ -0,0 +1,84 @@
+"""Main module of a Centrifuge Python client library."""
+
+from .client import Client, ClientState, Subscription, SubscriptionState, DeltaType
+from .contexts import (
+    ConnectedContext,
+    ConnectingContext,
+    DisconnectedContext,
+    ErrorContext,
+    JoinContext,
+    LeaveContext,
+    PublicationContext,
+    ServerJoinContext,
+    ServerLeaveContext,
+    ServerPublicationContext,
+    ServerSubscribedContext,
+    ServerSubscribingContext,
+    ServerUnsubscribedContext,
+    SubscribedContext,
+    SubscribingContext,
+    SubscriptionErrorContext,
+    UnsubscribedContext,
+)
+from .exceptions import (
+    CentrifugeError,
+    ClientDisconnectedError,
+    OperationTimeoutError,
+    DuplicateSubscriptionError,
+    ReplyError,
+    SubscriptionUnsubscribedError,
+    UnauthorizedError,
+)
+from .handlers import ClientEventHandler, SubscriptionEventHandler
+from .types import (
+    ClientInfo,
+    HistoryResult,
+    PresenceResult,
+    PresenceStatsResult,
+    Publication,
+    PublishResult,
+    RpcResult,
+    StreamPosition,
+)
+
+__all__ = [
+    "CentrifugeError",
+    "Client",
+    "ClientDisconnectedError",
+    "ClientEventHandler",
+    "ClientInfo",
+    "ClientState",
+    "ConnectedContext",
+    "ConnectingContext",
+    "DeltaType",
+    "DisconnectedContext",
+    "DuplicateSubscriptionError",
+    "ErrorContext",
+    "HistoryResult",
+    "JoinContext",
+    "LeaveContext",
+    "OperationTimeoutError",
+    "PresenceResult",
+    "PresenceStatsResult",
+    "Publication",
+    "PublicationContext",
+    "PublishResult",
+    "ReplyError",
+    "RpcResult",
+    "ServerJoinContext",
+    "ServerLeaveContext",
+    "ServerPublicationContext",
+    "ServerSubscribedContext",
+    "ServerSubscribingContext",
+    "ServerUnsubscribedContext",
+    "StreamPosition",
+    "SubscribedContext",
+    "SubscribingContext",
+    "Subscription",
+    "SubscriptionErrorContext",
+    "SubscriptionEventHandler",
+    "SubscriptionState",
+    "SubscriptionUnsubscribedError",
+    "UnauthorizedError",
+    "UnsubscribedContext",
+]

markethub_ddn-1.0.0/centrifuge/__meta__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"