Metadata-Version: 1.2
Name: trustlines-relay
Version: 0.15.0
Summary: Relay Server for the Trustlines Network
Home-page: https://github.com/trustlines-protocol/relay
Author: Trustlines-Network
Author-email: contact@brainbot.com
License: MIT
Description: |Code style: black|
        
        .. image:: https://circleci.com/gh/trustlines-protocol/relay.svg?style=svg
            :target: https://circleci.com/gh/trustlines-protocol/relay
        
        trustlines relay server
        =======================
        This documents describes how to install the trustlines relay server
        for local development.
        
        If you're trying to setup a complete trustlines system, please visit
        `Running the trustlines system
        <https://github.com/trustlines-protocol/relay/blob/master/docs/RelayServer.md>`__
        
        The relay server provides a REST API. Please visit the `REST API
        Documentation
        <https://github.com/trustlines-protocol/relay/blob/master/docs/RelayAPI.md>`__
        page for more information.
        
        
        Installation
        ------------
        
        Prerequisites
        ~~~~~~~~~~~~~
        
        An installation of the relay server requires at least the following
        components:
        
        - PostgreSQL header files
        - Python 3.6 or up
        - pip
        
        Installation on Ubuntu
        ^^^^^^^^^^^^^^^^^^^^^^
        Please issue the following command to install the prerequisites on ubuntu 18.04::
        
            sudo apt install build-essential python3-dev libsecp256k1-dev \
            python3-virtualenv virtualenv pkg-config libssl-dev automake \
            autoconf libtool git libpq-dev
        
        
        Setup
        ~~~~~
        To install all needed development dependencies run the following commands in a
        fresh virtualenv::
        
            git clone https://github.com/trustlines-protocol/relay.git
            cd relay
            pip install -r dev-requirements.txt -r requirements.txt -e .
        
        If you plan to make changes to the source code and open pull requests
        on github, please consider initializing the pre-commit hooks. The
        installed git pre-commit hooks run flake8 and black among other things
        when committing changes to the git repository ::
        
            pre-commit install
            pre-commit run -a
        
        After running those commands, the relay server is ready to run. Please
        run `tl-relay --help` to get an overview of available options.
        
        
        Dependencies
        ~~~~~~~~~~~~
        To manage and pin the (sub)dependencies of the relay server we use
        `pip-tools <https://github.com/jazzband/pip-tools/>`__.
        We create two requirements files, one for the production environment (:code:`requirements.txt`) and one for the additional development
        requirements (:code:`dev-requirements.txt`). For the dev environment, you have to install both.
        The production dependencies are derived from the dependencies defined in :code:`setup.py`
        and constraint by :code:`constraints.in`. To add new dependencies, add them to :code:`setup.py` and then run :code:`./compile-requirements`.
        If wrong subdependencies create problems, you can restrict them with :code:`constraints.in`.
        The development requirements are derived from :code:`dev-requirements.in`. To add new development dependencies, add them to this file and then rerun
        :code:`./compile-requirements`.
        To upgrade the dependencies in the created requirement files, check out the available options for pip-tools and pass
        them to the compile script. To update all dependencies, run :code:`./compile-requirements.sh --upgrade`.
        
        Change log
        ----------
        
        See `CHANGELOG <https://github.com/trustlines-protocol/relay/blob/master/CHANGELOG.rst>`_.
        
        .. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/psf/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.6
