Metadata-Version: 2.1
Name: imshowtools
Version: 0.2.0
Summary: imshowtools contains simplified imshow functions to show multiple images and with other options
Home-page: https://github.com/saravanabalagi/imshowtools
Author: Saravanabalagi Ramachandran
Author-email: saravanabalagi@hotmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: matplotlib

# imshowtools

This library that allows you to view images in Jupyter notebooks in a much simpler way.

## Installation

To install imshowtools,

```python
pip install imshowtools
```

## Usage

Open a jupyter notebook and use imshowtools as shown below:

#### Show a Single Image
```python
from imshowtools import *
imshow(your_image)
```

#### Show Multiple Images
```python
from imshowtools import *
imshow(image_1, image_2, image_3)
```

#### Show Multiple Images from Array
```python
from imshowtools import *
imshow(*my_image_array)
```

#### Smart Wrapping
We choose the right layout for you:

* Have 6 images? You get 2x3
* Have 12 images? You get 3x4

#### Custom Rows and Columns
You can also choose to manually control how many rows and columns you
```python
from imshowtools import *
imshow(*my_image_array, rows=3, columns=4)
```

#### BGR Colorspace

OpenCV lover? `imshowtools` can also handle `cv2`'s BGR images
```python
from imshowtools import *
import cv2

cv2image = cv2.imread('my_image.png')
imshow(cv2image, mode='BGR')
```

#### Namespaces
If you do not want to use `imshow` directly in your app (maybe you have another function named imshow), you shall use it like

```python
import imshowtools
imshowtools.imshow(your_image)
```

or if you like to use a custom namespace
```python
import imshowtools as my_namespace
my_namespace.imshow(your_image)
```

## Uninstall

To uninstall `imshowtools`,

```python
pip uninstall imshowtools
```

## Licence

MIT License

Copyright (c) 2019 Saravanabalagi Ramachandran

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

