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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
Overview
==============
`eth-utils` provides common utility functions for codebases which interact with ethereum.
- This library and repository was previously located at
https://github.com/pipermerriam/ethereum-utils. It was transferred to
the Ethereum foundation github in November 2017 and renamed to
``eth-utils``. The PyPi package was also renamed from
``ethereum-utils`` to \`eth-utils\`.
Installation
------------
.. code:: sh
python -m pip install eth-utils
Development
-----------
Clone the repository and then run:
.. code:: sh
python -m pip install -e ".[dev]"
Documentation
-------------
Building Sphinx docs locally:
.. code:: sh
python -m pip install -e ".[docs]"
cd docs
make html
Docs are written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`__ and built using the
`Sphinx <http://www.sphinx-doc.org/>`__ documentation generator.
Running the tests
~~~~~~~~~~~~~~~~~
You can run the tests with:
.. code:: sh
pytest tests
Or you can install ``tox`` to run the full test suite.
Releasing
~~~~~~~~~
To release a new version:
.. code:: sh
make release bump=$$VERSION_PART_TO_BUMP$$
How to bumpversion
^^^^^^^^^^^^^^^^^^
The version format for this repo is ``{major}.{minor}.{patch}`` for
stable, and ``{major}.{minor}.{patch}-{stage}.{devnum}`` for unstable
(``stage`` can be alpha or beta).
To issue the next version in line, specify which part to bump, like
``make release bump=minor`` or ``make release bump=devnum``.
If you are in a beta version, ``make release bump=stage`` will switch to
a stable.
To issue an unstable version when the current version is stable, specify
the new version explicitly, like
``make release bump="--new-version 4.0.0-alpha.1 devnum"``
|
