diff options
Diffstat (limited to 'python-packages/contract_demo/README.md')
| -rw-r--r-- | python-packages/contract_demo/README.md | 39 |
1 files changed, 0 insertions, 39 deletions
diff --git a/python-packages/contract_demo/README.md b/python-packages/contract_demo/README.md deleted file mode 100644 index 3a0f964e3..000000000 --- a/python-packages/contract_demo/README.md +++ /dev/null @@ -1,39 +0,0 @@ -## 0x-contract-demo - -A demonstration of calling 0x smart contracts from Python. - -Read the [documentation](http://0x-contract-demo-py.s3-website-us-east-1.amazonaws.com/) - -## 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. |