A framework to connect other cryptocurrencies to the Waves-Platform.
Project description
Waves-Gateway-Framework
A framework to connect other cryptocurrencies to the Waves platform. Requires Python 3.5 or newer.
For detailed usage instructions please refer to the source code documentation that may be exported by using the commands described below. The framework exports a class Gateway. This class has to instantiated. Once done, the Gateway can be started by calling the run method on the resulting instance.
The constructor of the Gateway class requires instances of certain interfaces. Those interfaces define the required functionality that a concrete Gateway implementation has to provide. You may also take a look at an example implementation that realizes a Waves-Gateway for Litecoin: https://github.com/jansenmarc/WavesGatewayLTCExample.
Required packages for development
python3.5 -m pip install coverage mypy pylintLint
The PyLint package is required for linting. Install it like this: pip install pylint.
python3.5 setup.py lintMyPy
The MyPy package performs static type analysis to prevent errors.
python3.5 setup.py mypy
Unittest
python3.5 setup.py testThe convention is to write Unittests for every class in a separate file starting with test_ This is the default prefix of the python Unittest module.
Coverage
python3.5 setup.py coverageDocumentation Generation
Creates a folder docs with the generated HTML documentation.
python3.5 setup.py pydocDoctest
Doctests are not used in this project. Write Unittests instead.
yapf
This project uses yapf (https://github.com/google/yapf) as a formatting tool So, please format your code before commiting by running this:
python3.5 -m yapf -r waves_gateway --style pep8 --style {COLUMN_LIMIT:120} -iThe pipeline will fail if the code is not properly formatted.
Distribution
First, run npm run build:prod to update the assets. After that, run python3.5 setup.py sdist to create an installable tar archive.
Publish to test.pypi.org:
twine upload --repository-url https://test.pypi.org/legacy/ dist/*Regular publish:
twine upload dist/*Recommendations
Use Python 3.5 for development.
PyCharm users should enable Gevent compatible debugging: https://blog.jetbrains.com/pycharm/2012/08/gevent-debug-support/.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
