aboutsummaryrefslogtreecommitdiffstats
path: root/python-packages/order_utils/README.md
blob: a266694db78dcbef81509345b88c389e7efadbb5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
## 0x-order-utils

0x order-related utilities for those developing on top of 0x protocol.

Read the [documentation](https://0x.readthedocs.io/projects/order-utils/en/latest/)

## 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 Python >=3.6 installed, then:

```bash
pip install -e .[dev]
```

### Test

`./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.