Metadata-Version: 1.2
Name: eth-utils
Version: 2.0.0a0
Summary: Common utility functions for ethereum codebases.
Home-page: https://github.com/ethereum/eth_utils
Author: Piper Merriam
Author-email: pipermerriam@gmail.com
License: MIT
Description: Ethereum Utils
        ==============
        
        |Join the chat at https://gitter.im/ethereum/eth-utils|
        
        |Build Status|
        
        `Documentation hosted by
        ReadTheDocs <https://eth-utils.readthedocs.io/en/latest/>`__
        
        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
        
            pip install eth-utils
        
        Development
        -----------
        
        Clone the repository and then run:
        
        .. code:: sh
        
            pip install -e .[dev] eth-hash[pycryptodome]
        
        Documentation
        -------------
        
        Building Sphinx docs locally:
        
        .. code:: sh
        
            pip install -e .[doc]
            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
        
            py.test tests
        
        Or you can install ``tox`` to run the full test suite.
        
        Releasing
        ~~~~~~~~~
        
        Pandoc is required for transforming the markdown README to the proper
        format to render correctly on pypi.
        
        For Debian-like systems:
        
        ::
        
            apt install pandoc
        
        Or on OSX:
        
        .. code:: sh
        
            brew install pandoc
        
        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"``
        
        .. |Join the chat at https://gitter.im/ethereum/eth-utils| image:: https://badges.gitter.im/ethereum/eth-utils.svg
           :target: https://gitter.im/ethereum/eth-utils
        .. |Build Status| image:: https://circleci.com/gh/ethereum/eth-utils.svg?style=shield
           :target: https://circleci.com/gh/ethereum/eth-utils
        
Keywords: ethereum
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.5,!=3.5.2,<4
