signalrcore 0.8.7__tar.gz → 0.9.6b1__tar.gz

signalrcore-0.9.6b1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Andrés Baamonde Lozano
+
+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.

signalrcore-0.9.6b1/MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE

signalrcore-0.9.6b1/PKG-INFO

@@ -0,0 +1,342 @@
+Metadata-Version: 2.4
+Name: signalrcore
+Version: 0.9.6b1
+Summary: A Python SignalR Core client(json and messagepack),with invocation auth and two way streaming.Compatible with azure / serverless functions.Also with automatic reconnect and manually reconnect.
+Home-page: https://github.com/mandrewcito/signalrcore
+Author: mandrewcito
+Author-email: signalrcore@mandrewcito.dev
+Keywords: signalr core client 3.1
+Classifier: Programming Language :: Python :: 3.8
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: msgpack==1.0.2
+Provides-Extra: dev
+Requires-Dist: requests; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+# SignalR core client
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?logo=paypal&style=flat-square)](https://www.paypal.me/mandrewcito/1)
+![Pypi](https://img.shields.io/pypi/v/signalrcore.svg)
+[![Downloads](https://pepy.tech/badge/signalrcore/month)](https://pepy.tech/project/signalrcore/month)
+[![Downloads](https://pepy.tech/badge/signalrcore)](https://pepy.tech/project/signalrcore)
+![Issues](https://img.shields.io/github/issues/mandrewcito/signalrcore.svg)
+![Open issues](https://img.shields.io/github/issues-raw/mandrewcito/signalrcore.svg)
+![codecov.io](https://codecov.io/github/mandrewcito/signalrcore/coverage.svg?branch=master)
+
+![logo alt](https://raw.githubusercontent.com/mandrewcito/signalrcore/master/docs/img/logo_temp.128.svg.png)
+
+
+# Links 
+
+* [Dev to posts with library examples and implementation](https://dev.to/mandrewcito/singlar-core-python-client-58e7)
+
+* [Pypi](https://pypi.org/project/signalrcore/)
+
+* [Wiki - This Doc](https://mandrewcito.github.io/signalrcore/)
+
+# Develop
+
+Test server will be available in [here](https://github.com/mandrewcito/signalrcore-containertestservers) and docker compose is required.
+
+```bash
+git clone https://github.com/mandrewcito/signalrcore-containertestservers
+cd signalrcore-containertestservers
+docker compose up
+cd ../signalrcore
+make tests
+```
+
+# A Tiny How To
+
+## Connect to a server without auth
+
+```python
+hub_connection = HubConnectionBuilder()\
+    .with_url(server_url)\
+    .configure_logging(logging.DEBUG)\
+    .with_automatic_reconnect({
+        "type": "raw",
+        "keep_alive_interval": 10,
+        "reconnect_interval": 5,
+        "max_attempts": 5
+    }).build()
+```
+## Connect to a server with auth
+
+login_function must provide auth token
+
+```python
+hub_connection = HubConnectionBuilder()\
+            .with_url(server_url,
+            options={
+                "access_token_factory": login_function,
+                "headers": {
+                    "mycustomheader": "mycustomheadervalue"
+                }
+            })\
+            .configure_logging(logging.DEBUG)\
+            .with_automatic_reconnect({
+                "type": "raw",
+                "keep_alive_interval": 10,
+                "reconnect_interval": 5,
+                "max_attempts": 5
+            }).build()
+```
+### Unauthorized errors
+A login function must provide an error controller if authorization fails. When connection starts, if authorization fails exception will be propagated.
+
+```python
+    def login(self):
+        response = requests.post(
+            self.login_url,
+            json={
+                "username": self.email,
+                "password": self.password
+                },verify=False)
+        if response.status_code == 200:
+            return response.json()["token"]
+        raise requests.exceptions.ConnectionError()
+
+    hub_connection.start()   # this code will raise  requests.exceptions.ConnectionError() if auth fails
+```
+## Configure logging
+
+```python
+HubConnectionBuilder()\
+    .with_url(server_url,
+    .configure_logging(logging.DEBUG)
+    ...
+```
+## Configure socket trace
+```python 
+HubConnectionBuilder()\
+    .with_url(server_url,
+    .configure_logging(logging.DEBUG, socket_trace=True) 
+    ... 
+ ```
+## Configure your own handler
+```python
+ import logging
+handler = logging.StreamHandler()
+handler.setLevel(logging.DEBUG)
+hub_connection = HubConnectionBuilder()\
+    .with_url(server_url, options={"verify_ssl": False}) \
+    .configure_logging(logging.DEBUG, socket_trace=True, handler=handler)
+    ...
+ ```
+## Configuring reconnection
+After reaching max_attempts an exeption will be thrown and on_disconnect event will be fired.
+```python
+hub_connection = HubConnectionBuilder()\
+    .with_url(server_url)\
+    ...
+    .build()
+```
+## Configuring additional headers
+```python
+hub_connection = HubConnectionBuilder()\
+            .with_url(server_url,
+            options={
+                "headers": {
+                    "mycustomheader": "mycustomheadervalue"
+                }
+            })
+            ...
+            .build()
+```
+## Configuring additional querystring parameters
+```python
+server_url ="http.... /?myquerystringparam=134&foo=bar"
+connection = HubConnectionBuilder()\
+            .with_url(server_url,
+            options={
+            })\
+            .build()
+```
+## Configuring skip negotiation
+```python
+hub_connection = HubConnectionBuilder() \
+        .with_url("ws://"+server_url, options={
+            "verify_ssl": False,
+            "skip_negotiation": False,
+            "headers": {
+            }
+        }) \
+        .configure_logging(logging.DEBUG, socket_trace=True, handler=handler) \
+        .build()
+
+```
+## Configuring ping(keep alive)
+
+keep_alive_interval sets the seconds of ping message
+
+```python
+hub_connection = HubConnectionBuilder()\
+    .with_url(server_url)\
+    .configure_logging(logging.DEBUG)\
+    .with_automatic_reconnect({
+        "type": "raw",
+        "keep_alive_interval": 10,
+        "reconnect_interval": 5,
+        "max_attempts": 5
+    }).build()
+```
+## Configuring logging
+```python
+hub_connection = HubConnectionBuilder()\
+    .with_url(server_url)\
+    .configure_logging(logging.DEBUG)\
+    .with_automatic_reconnect({
+        "type": "raw",
+        "keep_alive_interval": 10,
+        "reconnect_interval": 5,
+        "max_attempts": 5
+    }).build()
+```
+
+## Configure messagepack
+
+```python
+from signalrcore.protocol.messagepack_protocol import MessagePackHubProtocol
+
+HubConnectionBuilder()\
+            .with_url(self.server_url, options={"verify_ssl":False})\
+                ... 
+            .with_hub_protocol(MessagePackHubProtocol())\
+                ...
+            .build()
+```
+## Events
+
+### On Connect / On Disconnect
+on_open - fires when connection is opened and ready to send messages
+on_close - fires when connection is closed
+```python
+hub_connection.on_open(lambda: print("connection opened and handshake received ready to send messages"))
+hub_connection.on_close(lambda: print("connection closed"))
+
+```
+### On Hub Error (Hub Exceptions ...)
+```
+hub_connection.on_error(lambda data: print(f"An exception was thrown closed{data.error}"))
+```
+### Register an operation 
+ReceiveMessage - signalr method
+print - function that has as parameters args of signalr method
+```python
+hub_connection.on("ReceiveMessage", print)
+```
+## Sending messages
+SendMessage - signalr method
+username, message - parameters of signalrmethod
+```python
+    hub_connection.send("SendMessage", [username, message])
+```
+
+## Sending messages with callback
+SendMessage - signalr method
+username, message - parameters of signalrmethod
+```python
+    send_callback_received = threading.Lock()
+    send_callback_received.acquire()
+    self.connection.send(
+        "SendMessage", # Method
+        [self.username, self.message], # Params
+        lambda m: send_callback_received.release()) # Callback
+    if not send_callback_received.acquire(timeout=1):
+        raise ValueError("CALLBACK NOT RECEIVED")
+```
+
+## Requesting streaming (Server to client)
+```python
+hub_connection.stream(
+            "Counter",
+            [len(self.items), 500]).subscribe({
+                "next": self.on_next,
+                "complete": self.on_complete,
+                "error": self.on_error
+            })
+```
+## Client side Streaming
+```python
+from signalrcore.subject import  Subject
+
+subject = Subject()
+
+# Start Streaming
+hub_connection.send("UploadStream", subject)
+
+# Each iteration
+subject.next(str(iteration))
+
+# End streaming
+subject.complete()
+```
+
+# Full Examples
+
+Examples will be avaiable [here](https://github.com/mandrewcito/signalrcore/tree/master/test/examples)
+It were developed using package from [aspnet core - SignalRChat](https://codeload.github.com/aspnet/Docs/zip/master) 
+
+## Chat example
+A mini example could be something like this:
+
+```python
+import logging
+import sys
+from signalrcore.hub_connection_builder import HubConnectionBuilder
+
+
+def input_with_default(input_text, default_value):
+    value = input(input_text.format(default_value))
+    return default_value if value is None or value.strip() == "" else value
+
+
+server_url = input_with_default('Enter your server url(default: {0}): ', "wss://localhost:44376/chatHub")
+username = input_with_default('Enter your username (default: {0}): ', "mandrewcito")
+handler = logging.StreamHandler()
+handler.setLevel(logging.DEBUG)
+hub_connection = HubConnectionBuilder()\
+    .with_url(server_url, options={"verify_ssl": False}) \
+    .configure_logging(logging.DEBUG, socket_trace=True, handler=handler) \
+    .with_automatic_reconnect({
+            "type": "interval",
+            "keep_alive_interval": 10,
+            "intervals": [1, 3, 5, 6, 7, 87, 3]
+        }).build()
+
+hub_connection.on_open(lambda: print("connection opened and handshake received ready to send messages"))
+hub_connection.on_close(lambda: print("connection closed"))
+
+hub_connection.on("ReceiveMessage", print)
+hub_connection.start()
+message = None
+
+# Do login
+
+while message != "exit()":
+    message = input(">> ")
+    if message is not None and message != "" and message != "exit()":
+        hub_connection.send("SendMessage", [username, message])
+
+hub_connection.stop()
+
+sys.exit(0)
+
+```

{signalrcore-0.8.7 → signalrcore-0.9.6b1}/README.md

@@ -1,10 +1,10 @@
 # SignalR core client
 [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?logo=paypal&style=flat-square)](https://www.paypal.me/mandrewcito/1)
 ![Pypi](https://img.shields.io/pypi/v/signalrcore.svg)
-![Pypi - downloads month](https://img.shields.io/pypi/dm/signalrcore.svg)
+[![Downloads](https://pepy.tech/badge/signalrcore/month)](https://pepy.tech/project/signalrcore/month)
+[![Downloads](https://pepy.tech/badge/signalrcore)](https://pepy.tech/project/signalrcore)
 ![Issues](https://img.shields.io/github/issues/mandrewcito/signalrcore.svg)
 ![Open issues](https://img.shields.io/github/issues-raw/mandrewcito/signalrcore.svg)
-![travis build](https://img.shields.io/travis/mandrewcito/signalrcore.svg)
 ![codecov.io](https://codecov.io/github/mandrewcito/signalrcore/coverage.svg?branch=master)
 
 ![logo alt](https://raw.githubusercontent.com/mandrewcito/signalrcore/master/docs/img/logo_temp.128.svg.png)
@@ -14,31 +14,23 @@
 
 * [Dev to posts with library examples and implementation](https://dev.to/mandrewcito/singlar-core-python-client-58e7)
 
-* [Pypy](https://pypi.org/project/signalrcore/)
+* [Pypi](https://pypi.org/project/signalrcore/)
 
 * [Wiki - This Doc](https://mandrewcito.github.io/signalrcore/)
 
 # Develop
 
-Test server will be avaiable in [here](https://github.com/mandrewcito/signalrcore-containertestservers) and docker compose is required.
+Test server will be available in [here](https://github.com/mandrewcito/signalrcore-containertestservers) and docker compose is required.
 
 ```bash
 git clone https://github.com/mandrewcito/signalrcore-containertestservers
 cd signalrcore-containertestservers
-docker-compose up
+docker compose up
 cd ../signalrcore
 make tests
 ```
 
-## known issues
-
-Issues related with closing socket inherited from websocket-client library. Due this problems i cant update library to versions higher than websocket-client 0.54.0. 
-I'm working for solve it, for now its patched (Error number 1. Raises an exception, and then exception is treated for prevent errors). 
-If i update weboscket library i fall into error number 2, on local machine i cant reproduce it but on travis builds fails (sometimes and randomly :()
-* [1. Closing socket error](https://github.com/slackapi/python-slackclient/issues/171)
-* [2. Random errors closing socket](https://github.com/websocket-client/websocket-client/issues/449)
-
-# A tiny How To
+# A Tiny How To
 
 ## Connect to a server without auth
 
@@ -74,8 +66,8 @@ hub_connection = HubConnectionBuilder()\
                 "max_attempts": 5
             }).build()
 ```
-### Unauthorized erros
-A login function must provide a error control if authorization fails. When connection starts, if authorization fails exception will be propagued.
+### Unauthorized errors
+A login function must provide an error controller if authorization fails. When connection starts, if authorization fails exception will be propagated.
 
 ```python
     def login(self):
@@ -106,8 +98,8 @@ HubConnectionBuilder()\
     .configure_logging(logging.DEBUG, socket_trace=True) 
     ... 
  ```
- ## Configure your own handler
- ```python
+## Configure your own handler
+```python
  import logging
 handler = logging.StreamHandler()
 handler.setLevel(logging.DEBUG)
@@ -116,16 +108,15 @@ hub_connection = HubConnectionBuilder()\
     .configure_logging(logging.DEBUG, socket_trace=True, handler=handler)
     ...
  ```
-## Configuring reconection
-After reaching max_attemps an exeption will be thrown and on_disconnect event will be
-fired.
+## Configuring reconnection
+After reaching max_attempts an exeption will be thrown and on_disconnect event will be fired.
 ```python
 hub_connection = HubConnectionBuilder()\
     .with_url(server_url)\
     ...
     .build()
 ```
-## Configuring aditional headers
+## Configuring additional headers
 ```python
 hub_connection = HubConnectionBuilder()\
             .with_url(server_url,
@@ -137,7 +128,7 @@ hub_connection = HubConnectionBuilder()\
             ...
             .build()
 ```
-## Configuring aditional querystring parameters
+## Configuring additional querystring parameters
 ```python
 server_url ="http.... /?myquerystringparam=134&foo=bar"
 connection = HubConnectionBuilder()\
@@ -146,7 +137,7 @@ connection = HubConnectionBuilder()\
             })\
             .build()
 ```
-## Congfigure skip negotiation
+## Configuring skip negotiation
 ```python
 hub_connection = HubConnectionBuilder() \
         .with_url("ws://"+server_url, options={
@@ -161,7 +152,7 @@ hub_connection = HubConnectionBuilder() \
 ```
 ## Configuring ping(keep alive)
 
-keep_alive_interval sets the secconds of ping message
+keep_alive_interval sets the seconds of ping message
 
 ```python
 hub_connection = HubConnectionBuilder()\
@@ -186,15 +177,32 @@ hub_connection = HubConnectionBuilder()\
         "max_attempts": 5
     }).build()
 ```
+
+## Configure messagepack
+
+```python
+from signalrcore.protocol.messagepack_protocol import MessagePackHubProtocol
+
+HubConnectionBuilder()\
+            .with_url(self.server_url, options={"verify_ssl":False})\
+                ... 
+            .with_hub_protocol(MessagePackHubProtocol())\
+                ...
+            .build()
+```
 ## Events
 
-### On connect / On disconnect
-on_open - fires when connection is openned and ready to send messages
+### On Connect / On Disconnect
+on_open - fires when connection is opened and ready to send messages
 on_close - fires when connection is closed
 ```python
 hub_connection.on_open(lambda: print("connection opened and handshake received ready to send messages"))
 hub_connection.on_close(lambda: print("connection closed"))
 
+```
+### On Hub Error (Hub Exceptions ...)
+```
+hub_connection.on_error(lambda data: print(f"An exception was thrown closed{data.error}"))
 ```
 ### Register an operation 
 ReceiveMessage - signalr method
@@ -208,6 +216,7 @@ username, message - parameters of signalrmethod
 ```python
     hub_connection.send("SendMessage", [username, message])
 ```
+
 ## Sending messages with callback
 SendMessage - signalr method
 username, message - parameters of signalrmethod
@@ -221,6 +230,7 @@ username, message - parameters of signalrmethod
     if not send_callback_received.acquire(timeout=1):
         raise ValueError("CALLBACK NOT RECEIVED")
 ```
+
 ## Requesting streaming (Server to client)
 ```python
 hub_connection.stream(
@@ -245,10 +255,6 @@ subject.next(str(iteration))
 
 # End streaming
 subject.complete()
-
-
-
-
 ```
 
 # Full Examples
@@ -301,4 +307,4 @@ hub_connection.stop()
 
 sys.exit(0)
 
-```
+```

signalrcore-0.9.6b1/setup.py

@@ -0,0 +1,38 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="signalrcore",
+    version="0.9.6b1",
+    author="mandrewcito",
+    author_email="signalrcore@mandrewcito.dev",
+    description="A Python SignalR Core client(json and messagepack),"
+    "with invocation auth and two way streaming."
+    "Compatible with azure / serverless functions."
+    "Also with automatic reconnect and manually reconnect.",
+    keywords="signalr core client 3.1",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    license_file="LICENSE",
+    url="https://github.com/mandrewcito/signalrcore",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3.8",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent"
+    ],
+    install_requires=[
+        "msgpack==1.0.2"
+    ],
+    extras_require={
+        'dev': [
+            'requests',
+            'flake8',
+            'coverage',
+            'pytest',
+            'pytest-cov'
+        ]
+    },
+)