Represent
---------

|PyPI Version| |Python Version| |MIT License|

Installation
~~~~~~~~~~~~

.. code:: bash

    $ pip install represent

Automatic Generation
~~~~~~~~~~~~~~~~~~~~

.. code:: python

    from represent import ReprMixin


    class Rectangle(ReprMixin, object):
        def __init__(self, name, color, width, height):
            self.name = name
            self.color = color
            self.width = width
            self.height = height

            super(Rectangle, self).__init__()

    rect = Rectangle('Timothy', 'red', 15, 4.5)
    print(rect)

::

    Rectangle(name='Timothy', color='red', width=15, height=4.5)

Declarative Generation
~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    from represent import ReprHelper


    class ContrivedExample(object):
        def __init__(self, description, radians, shape, color, miles):
            self.description = description
            self.degrees = radians * 180 / 3.141592654
            self.shape = shape
            self._color = color
            self.km = 1.60934 * miles

        def __repr__(self):
            r = ReprHelper(self)
            r.positional_from_attr('description')
            r.positional_with_value(self.degrees * 3.141592654 / 180)
            r.keyword_from_attr('shape')
            r.keyword_from_attr('color', '_color')
            r.keyword_with_value('miles', self.km / 1.60934)
            return str(r)

    ce = ContrivedExample('does something', 0.345, 'square', 'red', 22)
    print(ce)

::

    ContrivedExample('does something', 0.345, shape='square', color='red', miles=22.0)

For pretty printer support and more information, `visit the
documentation <http://pythonhosted.org/Represent/>`__!

.. |PyPI Version| image:: http://img.shields.io/pypi/v/represent.svg?style=flat-square
   :target: https://pypi.python.org/pypi/represent/
.. |Python Version| image:: https://img.shields.io/badge/python-2.7%2C%203-brightgreen.svg?style=flat-square
   :target: https://www.python.org/downloads/
.. |MIT License| image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
   :target: https://raw.githubusercontent.com/RazerM/represent/master/LICENSE
