Skip to content

Commit cd1151b

Browse files
doc: updating README to describes the tox-based production system
1 parent 631e5b3 commit cd1151b

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.rst

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,29 @@ If you're interested in using this library, please get involved.
3030
* Free software: Apache Software License 2.0
3131
* Documentation: https://python-etcd3.readthedocs.io.
3232

33-
Basic usage:
33+
34+
Building python package
35+
-----------------------
36+
37+
The package build is made using the ToX orchestrator.
38+
It is required to generate python files before building the package as they are
39+
not kept in gconf.
40+
You only need the ToX orchestrator to produce the package:
41+
42+
```
43+
pip install tox
44+
```
45+
46+
A typical build sequence is the folling:
47+
48+
```
49+
tox -e genproto
50+
tox -e build
51+
```
52+
53+
54+
Basic usage
55+
-----------
3456

3557
.. code-block:: python
3658

0 commit comments

Comments
 (0)