Skip to content

spacebro/pySpacebroClient

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pySpacebroClient

🌟 Connect easily to a [spacebro server](https://github.com/spacebro/spacebro).

a port of nodejs spacebro-client

Why

No more custom socket.io server.

Easily connect with socket.io to other clients.

Spacebro offers an API to connect clients input and output together.

Installation

pip install pySpacebroClient

Usage

  1. Connect
from pySpacebroClient import SpacebroClient

settings = {
    'host': 'spacebro.space',
    'port': 3333,
    'client': {
        'name': 'python-bro'
    },
    'channelName': 'mychannelname'
}
spacebroClient = SpacebroClient(settings)
spacebroClient.wait()
  1. Emit a message for an app called node-bro
from pySpacebroClient import SpacebroClient

settings = {
    'host': 'spacebro.space',
    'port': 3333,
    'client': {
        'name': 'python-bro'
        'out': {
            'outMedia': {
                'eventName': 'outMedia',
                'description': 'Output media',
                'type': 'all'
            }
        }
    },
    'channelName': 'mychannelname',
    'connection': 'python-bro/outMedia => node-bro/inMedia'
}
spacebroClient = SpacebroClient(settings)
spacebroClient.emit(settings.client.out.outMedia.eventName, {'value': 5})
spacebroClient.wait()
  1. Receive a message from an app called chokibro
from pySpacebroClient import SpacebroClient

def on_inMedia(self, args):
    print('received', args)

settings = {
    'host': 'spacebro.space',
    'port': 3333,
    'client': {
        'name': 'python-bro'
        'in': {
            'inMedia': {
                'eventName': 'inMedia',
                'description': 'Input media',
                'type': 'all'
            }
        }
    },
    'channelName': 'mychannelname',
    'connection': 'chokibro/outMedia => python-bro/inMedia'
}
spacebroClient = SpacebroClient(settings)
spacebroClient.on(settings.client['in'].inMedia.eventName, self.on_inMedia)
spacebroClient.wait()

test command

python -m tests.test

About

Connect easily to a spacebro server

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages