diff options
author | F. Eugene Aumson <feuGeneA@users.noreply.github.com> | 2019-01-09 03:28:32 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-01-09 03:28:32 +0800 |
commit | 4689f20b86333d74fa0ccd45b23c560a0a0361b5 (patch) | |
tree | 9b1810a912a7c866d6be3799b24feea9c9f49d1f /python-packages/json_schemas/README.md | |
parent | de927d7207571e99a009320d9a47ae9815c2e198 (diff) | |
parent | e62e61bf7145c0a8011e098aa22168416d01a781 (diff) | |
download | dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.gz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.bz2 dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.lz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.xz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.zst dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.zip |
Move json_schemas to its own package (#1435)
* Move zero_ex.json_schemas to its own package
* Support ALL the schemas
* Stop installing packages as editable
* HACK: cp files because CircleCI isn't
* Add example usage to sra_client README
* Tweak special case: only strip Schema as suffix
* Correct doc titles
* Clarify what kind of support ticket was raised.
* Correct inconsistencies in JSON schema names
In both ref ID's and file names.
* Add entry point for validation of JSON strings
Diffstat (limited to 'python-packages/json_schemas/README.md')
-rw-r--r-- | python-packages/json_schemas/README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/python-packages/json_schemas/README.md b/python-packages/json_schemas/README.md new file mode 100644 index 000000000..ef8e888f3 --- /dev/null +++ b/python-packages/json_schemas/README.md @@ -0,0 +1,45 @@ +## 0x-json-schemas + +0x JSON schemas for those developing on top of 0x protocol. + +Read the [documentation](http://0x-json-schemas-py.s3-website-us-east-1.amazonaws.com/) + +## Installing + +```bash +pip install 0x-json-schemas +``` + +## 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. |