A SaltyRTC compliant signalling server.
Project description
This is a SaltyRTC server implementation for Python 3.4+ using asyncio.
Note
On machines where Python 3 is not the default Python runtime, you should use pip3 instead of pip.
Prerequisites
$ sudo apt-get install python3 python3-pip
We recommend using venv to create an isolated Python environment:
$ pyvenv venv
You can switch into the created virtual environment venv by running this command:
$ source venv/bin/activate
While the virtual environment is active, all packages installed using pip will be installed into this environment.
To deactivate the virtual environment, just run:
$ deactivate
If you want easier handling of your virtualenvs, you might also want to take a look at virtualenvwrapper.
Installation
If you are using a virtual environment, activate it first.
Install the module by running:
$ pip install saltyrtc.server
The dependency libnacl will be installed automatically. However, you may need to install libsodium for libnacl to work.
Command Line Usage
The script saltyrtc-server will be automatically installed and provides a command line interface for the server. Run the following command to see usage information:
$ saltyrtc-server --help
Contributing
If you want to contribute to this project, you should install the optional dev requirements of the project in an editable environment:
$ git clone https://github.com/saltyrtc/saltyrtc-server-python.git
$ cd saltyrtc-server-python
$ pip install -e .[dev]
Before creating a pull request, it is recommended to run the following commands to check for code style violations (flake8), optimise imports (isort) and run the project’s tests:
$ flake8 .
$ isort -rc .
$ py.test
Reporting Security Issues
Please report security issues directly to one or both of the following contacts:
Danilo Bargen
Email: mail@dbrgn.ch
Threema: EBEP4UCA
Lennart Grahl
Email: lennart.grahl@gmail.com
Threema: MSFVEW6C
Changelog
1.0.1 (2017-07-25)
Fix to handle new libnacl exceptions.
1.0.0 (2017-03-24)
Add server implementation of the SaltyRTC 1.0 Protocol
Initial publication on PyPI
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for saltyrtc.server-1.0.1-py34.py35.py36-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9cbd4293cb57ffdfc2b8f25bfe4851dd2ae06a4c6465e3b4fb3b0d51bb6dd67 |
|
MD5 | c7f2c79cfaffee9663af416c95b8d218 |
|
BLAKE2b-256 | 049e6f841d88459ad0bc73fb5c17899a7454eb9285e130fa39e7873531591657 |