Metadata-Version: 1.0
Name: imgdisplay
Version: 2016.12.26.19.22
Summary: A command-line app to slideshow photos in a directory.
Home-page: https://github.com/ericmjl/imgdisplay
Author: Eric J. Ma
Author-email: ericmajinglong@gmail.com
License: Copyright 2016 Eric J. Ma

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: # imgdisplay
        
        A simple Python app to display images in a standalone window.
        
        ## design goals:
        
        1. Built by a hacker for other hackers. End-user is comfortable with running command line programs.
        1. Cross-platform (Mac (tested), Linux (not yet tested), Windows (not yet tested))
        1. Easily installable with minimal dependencies.
        1. Executable from any directory.
        1. Does one thing and only one thing well.
        1. Not intended to be used as a library.
        
        ## purpose
        
        I created this command-line app to enable anybody to display images in a random order when run from a given directory. It does nothing but this. Feel free to hack it to do something else!
        
        ## intended use cases
        
        - Raspberry Pi photo display.
        
        ## philosophy
        
        We should be hacking our own solutions where possible. Reduce dependency on closed-source tools.
        
        ## features
        
        The app effectively keeps monitoring the folder it was run from for new images. This means that if you dump in a new folder, it'll be automatically be added to the list of images that can be displayed. Likewise, if you remove it from the folder, it'll automatically be removed from the list of images that can be displayed. Empty folders also won't cause problems, it'll just display a note "No images in directory.", and continue refreshing every 5 seconds until you put in new images there.
        
        # installation
        
        Via `pip`:
        
        ```bash
        $ pip install imgdisplay
        ```
        
        Via `conda`:
        ```bash
        $ conda install imgdisplay
        ```
        
        # usage
        
        To run:
        
        ```bash
        $ cd /path/to/images/
        $ imgdisplay
        ```
        
        To view help & options:
        
        ```bash
        $ imgdisplay --help
         ```
        
        To close/exit: close the terminal window, or close the app window. Both will do just fine.
        
        # roadmap & future improvements
        
        - add ability to control time between refresh.
        
Platform: UNKNOWN
