swimos/swim-system-python

Standalone Python framework for building massively real-time streaming WARP clients.

swim-system-python's Issues

Improve the project description in the main repository

Add custom exceptions.

Implement `command` method for the client

When the client stops it should set the status of all related downlinks to `Closed`

Add better exception handling for opening websockets and sending data

Add unit tests for `structures` module

Add status for the swim client

The swim client should have state and appropriate exceptions should be thrown if methods are called before the client is open.

Implement list downlink

Formalise the public API

Some of the classes and methods in the client need to be refactored to be private.

Increase the test coverage

Add additional unit tests to verify the Recon parser and Writer implementations.

Add support for WSS.

Add integration tests

It will be good to have some integration tests to detect any regression in the client as early as possible. For starters, the cookbook examples can be automated and used as integration tests for the current version of the client.

Refactor unit tests

The unit tests for the parser can be refactored to compare the actual object with values directly.

Improve the exception handling for the Swim Client.

Add Downlink Views.

Add code coverage for the CI/CD

Implement event downlink

Add unit tests for `warp` module

Add timeout for WebSocket connections.

Add unit tests for `recon` module

Replace executor with custom wrapper for non async functions.

Implement custom `str` methods for the `structures` module.

Implement Bool message writer and parser

Implement `Unlinked Response` in Recon module

Implement object to Recon serializer

Implement map downlinks

Map downlinks do not receive updates before sync

Map downlinks do not receive updates before sync.

Missing files in sdist

It appears that the manifest is missing at least one file necessary to build
from the sdist for version 1.0.0a0. You're in good company, about 5% of other
projects updated in the last year are also missing files.

+ /tmp/venv/bin/pip3 wheel --no-binary swimai -w /tmp/ext swimai==1.0.0a0
Looking in indexes: http://10.10.0.139:9191/root/pypi/+simple/
Collecting swimai==1.0.0a0
  Downloading http://10.10.0.139:9191/root/pypi/%2Bf/f48/eb5f80f51d210/swimai-1.0.0a0.tar.gz (60 kB)
    ERROR: Command errored out with exit status 1:
     command: /tmp/venv/bin/python3 -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-wheel-6pzku6q_/swimai/setup.py'"'"'; __file__='"'"'/tmp/pip-wheel-6pzku6q_/swimai/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base /tmp/pip-wheel-6pzku6q_/swimai/pip-egg-info
         cwd: /tmp/pip-wheel-6pzku6q_/swimai/
    Complete output (5 lines):
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "/tmp/pip-wheel-6pzku6q_/swimai/setup.py", line 20, in <module>
        with open('requirements.txt') as f:
    FileNotFoundError: [Errno 2] No such file or directory: 'requirements.txt'
    ----------------------------------------
ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.

Implement automatic conversion for primitive types to structure objects.

Add support for nested structures for the Recon parser and writer

Implement `close()` method for downlinks

Implement `get()` method for ValueDownlink

Priority and rate for Envelopes are not being parsed

When a Recon message with priority or rate specified is parsed, the resulting envelope object does not contain the correct values.

Improve the code documentation

Add `warp` alias for `ws` protocol

ws://localhost:9001 and warp://localhost:9001 should both be valid URIs

Add unit tests for `client` module

Complete missing documentation and type annotations

Implement Recon to object deserializer

Increase unit test coverage for downlinks.

Recon writer treats zero as None

Add synchronous flag for downlinks `set` method.

Add type annotations in the code

Create a custom class for URI to encapsulate the scheme normalisation.

Implement map downlink

Downlink Views should always re-send the original value.

When a downlink value is first created it receives event from the server and it's didSet method is triggered. However, because downlinks for the same lane share a model, when a second one is open the didSet is never triggered.

Add copyright info to all project files.

Add support for `with` statements for the python client.