populus

POPULUS

|Gitter chat| |Build Status| |Documentation Status| |PyPi version| |PyPi downloads|

Development framework for Ethereum smart contracts

Documentation

Documentation on ReadTheDocs <http://populus.readthedocs.org/en/latest/>__

Installation

.. code:: sh

pip install populus

Development

.. code:: sh

pip install -e . -r requirements-dev.txt

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

    bumpversion $$VERSION_PART_TO_BUMP$$
    git push && git push --tags
    make release

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, use bumpversion and specify which
part to bump, like ``bumpversion minor`` or ``bumpversion devnum``.

If you are in a beta version, ``bumpversion stage`` will switch to a
stable.

To issue an unstable version when the current version is stable, specify
the new version explicitly, like
``bumpversion --new-version 4.0.0-alpha.1 devnum``

.. |Gitter chat| image:: https://badges.gitter.im/ethereum/populus.png
   :target: https://gitter.im/ethereum/populus
.. |Build Status| image:: https://travis-ci.org/ethereum/populus.png
   :target: https://travis-ci.org/ethereum/populus
.. |Documentation Status| image:: https://readthedocs.org/projects/populus/badge/?version=latest
   :target: https://readthedocs.org/projects/populus/?badge=latest
.. |PyPi version| image:: https://pypip.in/v/populus/badge.png
   :target: https://pypi.python.org/pypi/populus
.. |PyPi downloads| image:: https://pypip.in/d/populus/badge.png
   :target: https://pypi.python.org/pypi/populus