Metadata-Version: 1.2
Name: trustlines-relay
Version: 0.6.1
Summary: Relay Server for the Trustlines Network
Home-page: https://github.com/trustlines-network/relay
Author: Trustlines-Network
Author-email: contact@brainbot.com
License: MIT
Description: |Code style: black|
        
        trustlines relay server
        =======================
        
        Installation
        ------------
        
        Prerequisites
        ~~~~~~~~~~~~~
        
        -  Python 3.6 or up
        -  pip
        
        Installation on Ubuntu
        ^^^^^^^^^^^^^^^^^^^^^^
        
        ::
        
            sudo apt install build-essential python3-dev libsecp256k1-dev python3-virtualenv virtualenv pkg-config libssl-dev automake autoconf libtool libgraphviz-dev git
        
        
        
        Setup
        ~~~~~
        To install all needed development dependencies run the following commands in a
        fresh virtualenv::
        
            git clone https://github.com/trustlines-network/relay.git
            cd relay
            pip install -c constraints.txt -r requirements.txt
            pip install -c constraints.txt -e .
            pre-commit install
            pre-commit run -a
        
        The last two commands will install a git pre-commit hook and intitialize the pre-commit installation.
        The installed git pre-commit hooks run flake8 and black among other things when
        committing changes to the git repository.
        
        We also need to deploy trustlines smart contracts on a local node or
        testrpc as described
        `here <https://github.com/trustlines-network/contracts>`__.
        
        Add the ``address`` of the deployed ``Currency Network`` to the file
        ``/relay/networks``:
        
        Usage
        ~~~~~
        
        ::
        
            cd relay
            python trustlines.py
        
        Docs
        ----
        
        -  `REST API Documentation <./docs/RelayAPI.md>`__
        
        Change log
        ----------
        
        See `CHANGELOG <https://github.com/trustlines-network/relay/blob/develop/CHANGELOG.rst>`_.
        
        .. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/ambv/black
        
Keywords: trustlines
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3
