Metadata-Version: 2.1
Name: 0x-order-utils
Version: 4.0.0.dev4
Summary: Order utilities for 0x applications
Home-page: https://github.com/0xProject/0x-monorepo/tree/development/python-packages/order_utils
Author: F. Eugene Aumson
Author-email: feuGeneA@users.noreply.github.com
License: Apache 2.0
Keywords: ethereum cryptocurrency 0x decentralized blockchain dex exchange
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Other/Nonlisted Topic
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Requires-Dist: 0x-contract-addresses (==3.0.0.dev1)
Requires-Dist: 0x-contract-artifacts (==3.0.0.dev1)
Requires-Dist: 0x-json-schemas (==2.1.0.dev0)
Requires-Dist: deprecated
Requires-Dist: web3
Requires-Dist: eth-abi
Requires-Dist: eth-utils
Requires-Dist: mypy-extensions
Provides-Extra: dev
Requires-Dist: 0x-contract-wrappers (==2.0.0.dev4) ; extra == 'dev'
Requires-Dist: bandit ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Requires-Dist: coveralls ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: mypy-extensions ; extra == 'dev'
Requires-Dist: pycodestyle ; extra == 'dev'
Requires-Dist: pydocstyle ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'

## 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.


