261bced822
The latest version of Sphinx (documentation generation utility) was giving a warning (which we were configured to treat as an error) about there being multiple docstring definitions for the same class. This had never been flagged before.
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
More
See ./setup.py --help-commands for more info.