protocol/README.md at 88aac78282955510ba4c425b193eda912e1192f3

F. Eugene Aumson 43443d6057

fix(order_utils.py): publish docs to S3, not RTD (#1264 )

Publishing to readthedocs.io (RTD) wasn't working, for various reasons.

Changed to publish docs to S3.

2018-11-17 07:07:25 -05:00

1.1 KiB

Raw Blame History

0x-order-utils

0x order-related utilities for those developing on top of 0x protocol.

Read the documentation

Installing

pip install 0x-order-utils

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install Code and Dependencies

Ensure that you have installed Python >=3.6 and Docker. Then:

pip install -e .[dev]

Test

Tests depend on a running ganache instance with the 0x contracts deployed in it. For convenience, a docker container is provided that has ganache-cli and a snapshot containing the necessary contracts. A shortcut is provided to run that docker container: ./setup.py ganache. With that running, the tests can be run with ./setup.py test.

Clean

./setup.py clean --all

Lint

./setup.py lint

Build Documentation

./setup.py build_sphinx

See ./setup.py --help-commands for more info.

1.1 KiB Raw Blame History