Relay Server for the Trustlines Network
Project description
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
The relay server provides a REST API. Please visit the REST API Documentation 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.
We create two requirements files, one for the production environment (requirements.txt
) and one for the additional development
requirements (dev-requirements.txt
). For the dev environment, you have to install both.
The production dependencies are derived from the dependencies defined in setup.py
and constraint by constraints.in
. To add new dependencies, add them to setup.py
and then run ./compile-requirements
.
If wrong subdependencies create problems, you can restrict them with constraints.in
.
The development requirements are derived from dev-requirements.in
. To add new development dependencies, add them to this file and then rerun
./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 ./compile-requirements.sh --upgrade
.
Change log
See CHANGELOG.
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
Hashes for trustlines-relay-0.15.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7690d2d6630076f5d49c99030c5c6a8d26abea8eb6a4b115151fb77ddd08cda4 |
|
MD5 | 0bb7db5f4243ce6ef8445d72b8868de5 |
|
BLAKE2b-256 | e389a2bc8338d820098a1da666b27381a22f076d7533dae1151524a883733bd4 |