diff options
| author | Hsuan Lee <boczeratul@gmail.com> | 2019-03-06 17:46:50 +0800 |
|---|---|---|
| committer | Hsuan Lee <boczeratul@gmail.com> | 2019-03-06 17:46:50 +0800 |
| commit | 35703539d0f2b4ddb3b11d0de8c9634af59ab71f (patch) | |
| tree | ae3731221dbbb3a6fa40060a8d916cfd3f738289 /python-packages/order_utils/README.md | |
| parent | 92a1fde5b1ecd81b07cdb5bf0c9c1cd3544799db (diff) | |
| download | dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.gz dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.zst dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.zip | |
Deploy @dexon-foundation/0x.jsstable
Diffstat (limited to 'python-packages/order_utils/README.md')
| -rw-r--r-- | python-packages/order_utils/README.md | 45 |
1 files changed, 0 insertions, 45 deletions
diff --git a/python-packages/order_utils/README.md b/python-packages/order_utils/README.md deleted file mode 100644 index 2181c7a11..000000000 --- a/python-packages/order_utils/README.md +++ /dev/null @@ -1,45 +0,0 @@ -## 0x-order-utils - -0x order-related utilities for those developing on top of 0x protocol. - -Read the [documentation](http://0x-order-utils-py.s3-website-us-east-1.amazonaws.com/) - -## Installing - -```bash -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](../../CONTRIBUTING.md) before getting started. - -### Install Code and Dependencies - -Ensure that you have installed Python >=3.6 and Docker. Then: - -```bash -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. |