Merge pull request #63 from alcarney/develop

New Release v0.6.1

CHANGES.rst

@@ -1,3 +1,20 @@
+v0.6.1 [Unreleased]
+-------------------
+
+Added
+^^^^^
+
+- New :code:`preview` keyword argument to images, set this to :code:`False` if
+  you don't want a matplotlib figure returned.
+- New :code:`encode` keyword argument to images, setting this to :code:`True`
+  will return a base64 encoded string representation of the image in PNG format.
+
+Fixed
+^^^^^
+
+- Preview images are no longer displayed twice in jupyter notebooks
+- Preview images no longer display the x and y axis numbers.
+
 v0.6.0 - 2018-10-07
 -------------------
 

README.rst → README.md

@@ -1,39 +1,9 @@
-About
------
-
-.. list-table::
-   :stub-columns: 1
-
-   * - project
-     - |license| |gitter|
-   * - code
-     - |travis| |coveralls| |black|
-   * - pypi
-     - |version| |supported-versions|
-
-.. |travis| image:: https://travis-ci.org/alcarney/stylo.svg?branch=develop
-   :target: https://travis-ci.org/alcarney/stylo
-
-.. |coveralls| image:: https://coveralls.io/repos/github/alcarney/stylo/badge.svg?branch=develop
-   :target: https://coveralls.io/github/alcarney/stylo?branch=develop
-
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-   :target: https://github.com/ambv/black
-
-.. |version| image:: https://img.shields.io/pypi/v/stylo.svg
-   :alt: PyPI Package latest release
-   :target: https://pypi.org/project/stylo
-
-.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/stylo.svg
-   :alt: Supported versions
-   :target: https://pypi.org/project/stylo
-
-.. |license| image:: https://img.shields.io/github/license/alcarney/stylo.svg
-   :alt: License
-
-.. |gitter| image:: https://badges.gitter.im/stylo-py/Lobby.svg
-   :alt: Join the chat at https://gitter.im/stylo-py/Lobby
-   :target: https://gitter.im/stylo-py/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+# Stylo
+|   |   |
+|:-------------:|----|
+| **Project** | ![MIT License](https://img.shields.io/github/license/alcarney/stylo.svg) [![Gitter](https://badges.gitter.im/stylo-py/Lobby.svg)](https://gitter.im/stylo-py/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
+| **Code**| [![Travis](https://travis-ci.org/alcarney/stylo.svg?branch=develop)](https://travis-ci.org/alcarney/stylo) [![Coveralls](https://coveralls.io/repos/github/alcarney/stylo/badge.svg?branch=develop)](https://coveralls.io/github/alcarney/stylo?branch=develop) [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)|
+| **PyPi** | [![PyPi Version](https://img.shields.io/pypi/v/stylo.svg)](https://pypi.org/project/stylo) [![PyPi Supported Versions](https://img.shields.io/pypi/pyversions/stylo.svg)](https://pypi.org/project/stylo)|
 
 **Stylo is in early development, while it is useable we cannot make any
 stability guarantees.**
@@ -46,16 +16,10 @@ For example here is a simple image of a boat that can be made with just a few
 lines of Python
 
 
-.. image:: /_static/examples/a-boat.png
-   :align: center
-   :width: 75%
+![A Boat](https://raw.githubusercontent.com/alcarney/stylo/develop/img/a-boat.png)
 
-.. image:: /img/a-boat.png
-   :align: center
-   :width: 75%
-
-.. testcode:: readme-boat
 
+```python
   from stylo.image import LayeredImage
   from stylo.color import FillColor
   from stylo.shape import Circle, Rectangle, Triangle
@@ -90,27 +54,26 @@ lines of Python
   image.add_layer(sails, white)
 
   image(1920, 1080, filename="docs/_static/examples/a-boat.png");
+```
 
-Installation
-^^^^^^^^^^^^
+## Installation
 
 Stylo is available for Python 3.5+ and can be installed using Pip:
 
-.. code::
-
-    $ pip install stylo
+```sh
+$ pip install stylo
+```
 
-Be sure to check out the `documentation <https://alcarney.github.io/stylo>`_
+Be sure to check out the [documentation](https://alcarney.github.io/stylo)
 (under construction) for details on how to get started with stylo.
 
-Contributing
-^^^^^^^^^^^^
+## Contributing
 
-Contributions are welcome! Be sure to checkout the `Contributing
-<https://alcarney.github.io/stylo/contributing/>`_ section of the documentation
-to get started.
+Contributions are welcome! Be sure to checkout the
+[Contributing](https://alcarney.github.io/stylo/contributing/) section of the
+documentation to get started.
 
-**Note:** While :code:`stylo` itself supports Python 3.5+, due to some of the
+**Note:** While `stylo` itself supports Python 3.5+, due to some of the
 development tools we use you need to have Python 3.6+ in order to contribute
 **code** to the library. Other versions of Python work just as well if you are
 looking to contribute documentation.

Untitled.ipynb

@@ -0,0 +1,75 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 37,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from stylo.shape import Square\n",
+    "from stylo.color import FillColor\n",
+    "from stylo.domain.transform import translate, rotate\n",
+    "from stylo.image import SimpleImage\n",
+    "\n",
+    "from math import pi\n",
+    "\n",
+    "red = FillColor(\"ff0000\")\n",
+    "\n",
+    "%matplotlib inline"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 38,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "square = Square(0, 0, 0.4) >> translate(-0.4, -0.4) >> rotate(pi/4) "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 39,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "image/png": "iVBORw0KGgoAAAANSUhEUgAAAQYAAAD8CAYAAACVSwr3AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAALEgAACxIB0t1+/AAAADl0RVh0U29mdHdhcmUAbWF0cGxvdGxpYiB2ZXJzaW9uIDMuMC4wLCBodHRwOi8vbWF0cGxvdGxpYi5vcmcvqOYd8AAADu5JREFUeJzt3H+IZWd9x/H3p9n8sNW6JpmGsLt2Iy5I/mhjGGJEKTbBElMx+SNKROoiCwutBcWC3bTQIvQP7R9GhaJdGula/JHUH2QJaW2aREr/MGZifpgfjRnFkF2iO2oSLWLb6Ld/zLN6s8+uc2fn3rk/5v2CyzznOc+d+z2783zuOeeec1NVSNKgX5t0AZKmj8EgqWMwSOoYDJI6BoOkjsEgqTOWYEhyVZLHkywnOTCO15A0Phn1dQxJzgC+CbwROALcC7y9qh4d6QtJGptx7DFcBixX1ber6n+BzwHXjOF1JI3JtjH8zh3AUwPLR4DX/KonnH/++bV79+4xlCLpuPvuu+/7VbUwzNhxBMNQkuwH9gO8/OUvZ2lpaVKlSFtCkieHHTuOQ4mjwK6B5Z2t7wWq6mBVLVbV4sLCUCEmaZOMIxjuBfYkuSjJWcD1wOExvI6kMRn5oURVPZ/kT4EvA2cAn6yqR0b9OpLGZyznGKrqduD2cfxuSePnlY+SOgaDpI7BIKljMEjqGAySOgaDpI7BIKljMEjqGAySOgaDpI7BIKljMEjqGAySOgaDpI7BIKljMEjqGAySOgaDpI7BIKljMEjqGAySOgaDpI7BIKljMEjqGAySOgaDpI7BIKljMEjqGAySOgaDpI7BIKljMEjqGAySOgaDpM6awZDkk0mOJXl4oO/cJHckeaL9fFnrT5KPJVlO8lCSS8dZvKTxGGaP4R+Bq07oOwDcWVV7gDvbMsCbgD3tsR/4+GjKlLSZ1gyGqvoP4IcndF8DHGrtQ8C1A/2fqlVfBbYnuXBUxUraHKd7juGCqnq6tb8LXNDaO4CnBsYdaX2dJPuTLCVZWllZOc0yJI3Dhk8+VlUBdRrPO1hVi1W1uLCwsNEyJI3Q6QbD944fIrSfx1r/UWDXwLidrU/SDDndYDgM7G3tvcCtA/3vbJ9OXA48N3DIIWlGbFtrQJLPAm8Azk9yBPhr4IPALUn2AU8Cb2vDbweuBpaBnwDvGkPNksZszWCoqrefYtWVJxlbwLs3WpSkyfLKR0kdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg2GjkklXII2cwbARx0PBcNCcMRhO14lhYDhojhgMp+NUIWA4aE6sGQxJdiW5O8mjSR5J8p7Wf26SO5I80X6+rPUnyceSLCd5KMml496ITbXW5DccNAeG2WN4HvizqroYuBx4d5KLgQPAnVW1B7izLQO8CdjTHvuBj4+86kkZdtIbDppxawZDVT1dVV9v7R8DjwE7gGuAQ23YIeDa1r4G+FSt+iqwPcmFI698s613shsOmmHrOseQZDfwauAe4IKqerqt+i5wQWvvAJ4aeNqR1je7nOTaYoYOhiQvBr4AvLeqfjS4rqoKqPW8cJL9SZaSLK2srKznqZtrI6GQGCqaSUMFQ5IzWQ2FT1fVF1v3944fIrSfx1r/UWDXwNN3tr4XqKqDVbVYVYsLCwunW/94jWpSGw6aMcN8KhHgJuCxqvrwwKrDwN7W3gvcOtD/zvbpxOXAcwOHHLPDyawtbNsQY14H/BHwjSQPtL6/AD4I3JJkH/Ak8La27nbgamAZ+AnwrpFWvBnGEQrHf2et64hLmog1g6Gq/hM41Uy58iTjC3j3BuuanHHvKSSGg6aeVz4O8vBBAgyGX9rMUPDTCk05gwEmN0kNB00pg0FSZ5hPJebXNLxj+2mFptDW3WOYhlAYNG31aEvbusEg6ZS23qHENL8ze1ihKbG19himORQGzUqdmltbJxhmbbLNWr2aK1sjGGZ1ks1q3Zp58x8Msz65Zr1+zaT5DoZ5mVTzsh2aGfMbDPM2meZtezTV5jMY5nUSzet2aerMXzDM++SZ9+3TVJivYNgqk2arbKcmZn6Cwckijcz8BIOkkZmfYPD+Amlk5icYYOuEw1bZTk3MfAUDzP+kmfft01SYv2CA+Z0887pdmjrzGQwwf5No3rZHU21+gwHmZzLNy3ZoZsx3MMDsT6pZr18zaf6DAWZ3cs1q3Zp5WyMYYPYm2azVq7mydYIBZmeyzUqdmltb71uij0+6aby3wkDQlNhaewyShrJ1g2Ha3p2nrR5taVvvUGLQNBxWGAiaQlt3j0HSKa0ZDEnOSfK1JA8meSTJB1r/RUnuSbKc5OYkZ7X+s9vyclu/e7ybMAKTetd2b0FTapg9hv8Brqiq3wUuAa5KcjnwIeDGqnol8Aywr43fBzzT+m9s46bfZk7SKkNBU23NYKhV/90Wz2yPAq4APt/6DwHXtvY1bZm2/spkGj8bPAknqwQMeY4hyRlJHgCOAXcA3wKerarn25AjwI7W3gE8BdDWPwecd5LfuT/JUpKllZWVjW3FKI07HAwfzYChgqGqflZVlwA7gcuAV230havqYFUtVtXiwsLCRn/daI1j8nr4oBmyrk8lqupZ4G7gtcD2JMc/7twJHG3to8AugLb+pcAPRlLtZnISawsb5lOJhSTbW/tFwBuBx1gNiOvasL3Ara19uC3T1t9VNaOzbFRlz+jma+sa5gKnC4FDSc5gNUhuqarbkjwKfC7J3wD3Aze18TcB/5RkGfghcP0Y6t48Vad/AZSBoBm1ZjBU1UPAq0/S/21Wzzec2P9T4K0jqW5abCQcpBnklY/DWu+7v3sLmmEGw3oMO9kNBc04g2G91pr0hoLmgMFwOk41+Q0FzQmD4XSdGAKGguaIwbARx8PAUNCcMRg2ylDQHDIYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkkdg0FSx2CQ1DEYJHUMBkmdoYMhyRlJ7k9yW1u+KMk9SZaT3JzkrNZ/dltebut3j6d0SeOynj2G9wCPDSx/CLixql4JPAPsa/37gGda/41tnKQZMlQwJNkJ/CHwD205wBXA59uQQ8C1rX1NW6atv7KNlzQjht1j+AjwfuDnbfk84Nmqer4tHwF2tPYO4CmAtv65Nv4FkuxPspRkaWVl5TTLlzQOawZDkjcDx6rqvlG+cFUdrKrFqlpcWFgY5a+WtEHbhhjzOuAtSa4GzgF+E/gosD3JtrZXsBM42sYfBXYBR5JsA14K/GDklUsamzX3GKrqhqraWVW7geuBu6rqHcDdwHVt2F7g1tY+3JZp6++qqhpp1ZLGaiPXMfw58L4ky6yeQ7ip9d8EnNf63wcc2FiJkjbbMIcSv1BVXwG+0trfBi47yZifAm8dQW2SJsQrHyV1DAZJHYNBUsdgkNQxGCR1DAZJHYNBUsdgkNQxGCR1DAZJHYNBUsdgkNQxGCR1DAZJHYNBUsdgkNQxGCR1DAZJHYNBUsdgkNQxGCR1DAZJHYNBUsdgkNQxGCR1DAZJHYNBUsdgkNQxGCR1DAZJHYNBUsdgkNQxGCR1DAZJnaGCIcl3knwjyQNJllrfuUnuSPJE+/my1p8kH0uynOShJJeOcwMkjd569hh+v6ouqarFtnwAuLOq9gB3tmWANwF72mM/8PFRFStpc2zkUOIa4FBrHwKuHej/VK36KrA9yYUbeB1Jm2zYYCjg35Lcl2R/67ugqp5u7e8CF7T2DuCpgeceaX0vkGR/kqUkSysrK6dRuqRx2TbkuNdX1dEkvwXckeS/BldWVSWp9bxwVR0EDgIsLi6u67mSxmuoPYaqOtp+HgO+BFwGfO/4IUL7eawNPwrsGnj6ztYnaUasGQxJfiPJS463gT8AHgYOA3vbsL3Ara19GHhn+3TicuC5gUMOSTNgmEOJC4AvJTk+/jNV9a9J7gVuSbIPeBJ4Wxt/O3A1sAz8BHjXyKuWNFapmvzhfZIfA49Puo4hnQ98f9JFDGFW6oTZqXVW6oST1/rbVbUwzJOHPfk4bo8PXB8x1ZIszUKts1InzE6ts1InbLxWL4mW1DEYJHWmJRgOTrqAdZiVWmelTpidWmelTthgrVNx8lHSdJmWPQZJU2TiwZDkqiSPt9u0D6z9jLHW8skkx5I8PNA3lbeXJ9mV5O4kjyZ5JMl7prHeJOck+VqSB1udH2j9FyW5p9Vzc5KzWv/ZbXm5rd+9GXUO1HtGkvuT3DbldY73qxCqamIP4AzgW8ArgLOAB4GLJ1jP7wGXAg8P9P0tcKC1DwAfau2rgX8BAlwO3LPJtV4IXNraLwG+CVw8bfW213txa58J3NNe/xbg+tb/CeCPW/tPgE+09vXAzZv87/o+4DPAbW15Wuv8DnD+CX0j+7/ftA05xca9FvjywPINwA0Trmn3CcHwOHBha1/I6jUXAH8PvP1k4yZU963AG6e5XuDXga8Dr2H14pttJ/4dAF8GXtva29q4bFJ9O1n9bpErgNvaRJq6OttrniwYRvZ/P+lDiaFu0Z6wDd1evhnabuyrWX03nrp62+75A6zeaHcHq3uJz1bV8yep5Rd1tvXPAedtRp3AR4D3Az9vy+dNaZ0whq9CGDQtVz7OhKr1314+bkleDHwBeG9V/ajd0wJMT71V9TPgkiTbWb0791UTLqmT5M3Asaq6L8kbJl3PEEb+VQiDJr3HMAu3aE/t7eVJzmQ1FD5dVV9s3VNbb1U9C9zN6i759iTH35gGa/lFnW39S4EfbEJ5rwPekuQ7wOdYPZz46BTWCYz/qxAmHQz3Anvamd+zWD2Jc3jCNZ1oKm8vz+quwU3AY1X14WmtN8lC21MgyYtYPQ/yGKsBcd0p6jxe/3XAXdUOjMepqm6oqp1VtZvVv8O7quod01YnbNJXIWzWyZJfcRLlalbPqH8L+MsJ1/JZ4Gng/1g9DtvH6nHjncATwL8D57axAf6u1f0NYHGTa309q8eZDwEPtMfV01Yv8DvA/a3Oh4G/av2vAL7G6u35/wyc3frPacvLbf0rJvB38AZ++anE1NXZanqwPR45Pm9G+X/vlY+SOpM+lJA0hQwGSR2DQVLHYJDUMRgkdQwGSR2DQVLHYJDU+X9CzhWBY4zbxgAAAABJRU5ErkJggg==\n",
+      "text/plain": [
+       "<Figure size 288x288 with 1 Axes>"
+      ]
+     },
+     "metadata": {
+      "needs_background": "light"
+     },
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "image = SimpleImage(square, red)\n",
+    "image(512, 512);"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.0"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}