Metadata-Version: 1.1
Name: picaxe
Version: 0.4.0
Summary: A python package and command-line tools to work with the Flickr API to upload images, sort images, generate MD image reference links etc
Home-page: https://github.com/thespacedoctor/picaxe
Author: David Young
Author-email: davidrobertyoung@gmail.com
License: MIT
Download-URL: https://github.com/thespacedoctor/picaxe/archive/v0.4.0.zip
Description: picaxe 
        =========================
        
        .. image:: https://readthedocs.org/projects/picaxe/badge/
            :target: http://picaxe.readthedocs.io/en/latest/?badge
            :alt: Documentation Status
        
        .. image:: https://cdn.rawgit.com/thespacedoctor/picaxe/master/coverage.svg
            :target: https://cdn.rawgit.com/thespacedoctor/picaxe/master/htmlcov/index.html
            :alt: Coverage Status
        
        *A python package and command-line tools for work with the Flickr API to upload images, sort images, generate MD image reference links etc*.
        
        Here's a summary of what's included in the python package:
        
        .. include:: /classes_and_functions.rst
        
        Command-Line Usage
        ==================
        
        .. code-block:: bash 
           
            
            Documentation for picaxe can be found here: http://picaxe.readthedocs.org/en/stable
            
            Usage:
                picaxe init
                picaxe auth [-s <pathToSettingsFile>]
                picaxe md <urlOrPhotoid> [<width>] [-s <pathToSettingsFile>]
                picaxe albums [-s <pathToSettingsFile>]
                picaxe [-giop] upload <imagePath> [--title=<title> --tags=<tags> --desc=<desc> --album=<album>]
                picaxe [-op] grab [--title=<title> --tags=<tags> --desc=<desc> --album=<album>]
            
            Options:
                init                  setup the polygot settings file for the first time
                auth                  authenticate picaxe against your flickr account
                md                    generate the MD reference link for the image in the given flickr URL
                albums                list all the albums in the flickr account
                upload                upload a local image to flickr
            
                <pathToSettingsFile>  path to the picaxe settings file
                <urlOrPhotoid>        the flickr URL or photoid
                <width>               pixel width resolution of the linked image. Default *original*. [75|100|150|240|320|500|640|800|1024|1600|2048]
                <imagePath>           path to the local image to upload to flickr
            
                --title=<title>       the image title
                --tags=<tags>         quoted, comma-sepatated tags
                --desc=<desc>         image description
                
                -p, --public          make the image public (private by default)
                -o, --open            open the image in the flickr web-app once uploaded
                -i, --image           "photo" is an image
                -g, --screenGrab      "photo" is a screengrab
                -h, --help            show this help message
                -v, --version         show version
                -s, --settings        the settings file
            
        
        Documentation
        =============
        
        Documentation for picaxe is hosted by `Read the Docs <http://picaxe.readthedocs.org/en/stable/>`__ (last `stable version <http://picaxe.readthedocs.org/en/stable/>`__ and `latest version <http://picaxe.readthedocs.org/en/latest/>`__).
        
        Installation
        ============
        
        The easiest way to install picaxe is to use ``pip``:
        
        .. code:: bash
        
            pip install picaxe
        
        Or you can clone the `github repo <https://github.com/thespacedoctor/picaxe>`__ and install from a local version of the code:
        
        .. code:: bash
        
            git clone git@github.com:thespacedoctor/picaxe.git
            cd picaxe
            python setup.py install
        
        To upgrade to the latest version of picaxe use the command:
        
        .. code:: bash
        
            pip install picaxe --upgrade
        
        
        Development
        -----------
        
        If you want to tinker with the code, then install in development mode.
        This means you can modify the code from your cloned repo:
        
        .. code:: bash
        
            git clone git@github.com:thespacedoctor/picaxe.git
            cd picaxe
            python setup.py develop
        
        `Pull requests <https://github.com/thespacedoctor/picaxe/pulls>`__
        are welcomed!
        
        Sublime Snippets
        ~~~~~~~~~~~~~~~~
        
        If you use `Sublime Text <https://www.sublimetext.com/>`_ as your code editor, and you're planning to develop your own python code with picaxe, you might find `my Sublime Snippets <https://github.com/thespacedoctor/picaxe-Sublime-Snippets>`_ useful. 
        
        Issues
        ------
        
        Please report any issues
        `here <https://github.com/thespacedoctor/picaxe/issues>`__.
        
        License
        =======
        
        Copyright (c) 2016 David Young
        
        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.
        
        
Keywords: flickr, images
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
