Metadata-Version: 1.2
Name: PyTumblr
Version: 0.1.0
Summary: A Python API v2 wrapper for Tumblr
Home-page: https://github.com/tumblr/pytumblr
Author: Tumblr
Author-email: accounts@tumblr.com
License: Apache Software License 2.0
Download-URL: https://github.com/tumblr/pytumblr/archive/0.1.0.tar.gz
Description: 
        PyTumblr
        ========
        |Build Status|
        
        Installation
        ============
        
        Install via pip:
        
        .. code-block:: bash
        
            $ pip install pytumblr
        
        Install from source:
        
        .. code-block:: bash
        
            $ git clone https://github.com/tumblr/pytumblr.git
            $ cd pytumblr
            $ python setup.py install
        
        Usage
        =====
        
        Create a client
        ---------------
        
        A ``pytumblr.TumblrRestClient`` is the object you'll make all of your calls to the Tumblr API through. Creating one is this easy:
        
        .. code:: python
        
            client = pytumblr.TumblrRestClient(
                '<consumer_key>',
                '<consumer_secret>',
                '<oauth_token>',
                '<oauth_secret>',
            )
        
            client.info() # Grabs the current user information
        
        Two easy ways to get your credentials to are:
        
        1. The built-in ``interactive_console.py`` tool (if you already have a consumer key & secret)
        2. The Tumblr API console at https://api.tumblr.com/console
        3. Get sample login code at https://api.tumblr.com/console/calls/user/info
        
        Supported Methods
        -----------------
        
        User Methods
        ~~~~~~~~~~~~
        
        .. code:: python
        
            client.info() # get information about the authenticating user
            client.dashboard() # get the dashboard for the authenticating user
            client.likes() # get the likes for the authenticating user
            client.following() # get the blogs followed by the authenticating user
        
            client.follow('codingjester.tumblr.com') # follow a blog
            client.unfollow('codingjester.tumblr.com') # unfollow a blog
        
            client.like(id, reblogkey) # like a post
            client.unlike(id, reblogkey) # unlike a post
        
        Blog Methods
        ~~~~~~~~~~~~
        
        .. code:: python
        
            client.blog_info(blogName) # get information about a blog
            client.posts(blogName, **params) # get posts for a blog
            client.avatar(blogName) # get the avatar for a blog
            client.blog_likes(blogName) # get the likes on a blog
            client.followers(blogName) # get the followers of a blog
            client.blog_following(blogName) # get the publicly exposed blogs that [blogName] follows
            client.queue(blogName) # get the queue for a given blog
            client.submission(blogName) # get the submissions for a given blog
        
        Post Methods
        ~~~~~~~~~~~~
        
        Creating posts
        ^^^^^^^^^^^^^^
        
        PyTumblr lets you create all of the various types that Tumblr supports. When using these types there are a few defaults that are able to be used with any post type.
        
        The default supported types are described below.
        
        -  **state** - a string, the state of the post. Supported types are *published*, *draft*, *queue*, *private*
        -  **tags** - a list, a list of strings that you want tagged on the post. eg: ["testing", "magic", "1"]
        -  **tweet** - a string, the string of the customized tweet you want. eg: "Man I love my mega awesome post!"
        -  **date** - a string, the customized GMT that you want
        -  **format** - a string, the format that your post is in. Support types are *html* or *markdown*
        -  **slug** - a string, the slug for the url of the post you want
        
        We'll show examples throughout of these default examples while showcasing all the specific post types.
        
        Creating a photo post
        '''''''''''''''''''''
        
        Creating a photo post supports a bunch of different options plus the described default options \* **caption** - a string, the user supplied caption \* **link** - a string, the "click-through" url for the photo \* **source** - a string, the url for the photo you want to use (use this or the data parameter) \* **data** - a list or string, a list of filepaths or a single file path for multipart file upload
        
        .. code:: python
        
            #Creates a photo post using a source URL
            client.create_photo(blogName, state="published", tags=["testing", "ok"],
                                source="https://68.media.tumblr.com/b965fbb2e501610a29d80ffb6fb3e1ad/tumblr_n55vdeTse11rn1906o1_500.jpg")
        
            #Creates a photo post using a local filepath
            client.create_photo(blogName, state="queue", tags=["testing", "ok"],
                                tweet="Woah this is an incredible sweet post [URL]",
                                data="/Users/johnb/path/to/my/image.jpg")
        
            #Creates a photoset post using several local filepaths
            client.create_photo(blogName, state="draft", tags=["jb is cool"], format="markdown",
                                data=["/Users/johnb/path/to/my/image.jpg", "/Users/johnb/Pictures/kittens.jpg"],
                                caption="## Mega sweet kittens")
        
        Creating a text post
        ''''''''''''''''''''
        
        Creating a text post supports the same options as default and just a two other parameters \* **title** - a string, the optional title for the post. Supports markdown or html \* **body** - a string, the body of the of the post. Supports markdown or html
        
        .. code:: python
        
            #Creating a text post
            client.create_text(blogName, state="published", slug="testing-text-posts", title="Testing", body="testing1 2 3 4")
        
        Creating a quote post
        '''''''''''''''''''''
        
        Creating a quote post supports the same options as default and two other parameter \* **quote** - a string, the full text of the qote. Supports markdown or html \* **source** - a string, the cited source. HTML supported
        
        .. code:: python
        
            #Creating a quote post
            client.create_quote(blogName, state="queue", quote="I am the Walrus", source="Ringo")
        
        Creating a link post
        ''''''''''''''''''''
        
        -  **title** - a string, the title of post that you want. Supports HTML entities.
        -  **url** - a string, the url that you want to create a link post for.
        -  **description** - a string, the desciption of the link that you have
        
        .. code:: python
        
            #Create a link post
            client.create_link(blogName, title="I like to search things, you should too.", url="https://duckduckgo.com",
                               description="Search is pretty cool when a duck does it.")
        
        Creating a chat post
        ''''''''''''''''''''
        
        Creating a chat post supports the same options as default and two other parameters \* **title** - a string, the title of the chat post \* **conversation** - a string, the text of the conversation/chat, with diablog labels (no html)
        
        .. code:: python
        
            #Create a chat post
            chat = """John: Testing can be fun!
            Renee: Testing is tedious and so are you.
            John: Aw.
            """
            client.create_chat(blogName, title="Renee just doesn't understand.", conversation=chat, tags=["renee", "testing"])
        
        Creating an audio post
        ''''''''''''''''''''''
        
        Creating an audio post allows for all default options and a has 3 other parameters. The only thing to keep in mind while dealing with audio posts is to make sure that you use the external\_url parameter or data. You cannot use both at the same time. \* **caption** - a string, the caption for your post \* **external\_url** - a string, the url of the site that hosts the audio file \* **data** - a string, the filepath of the audio file you want to upload to Tumblr
        
        .. code:: python
        
            #Creating an audio file
            client.create_audio(blogName, caption="Rock out.", data="/Users/johnb/Music/my/new/sweet/album.mp3")
        
            #lets use soundcloud!
            client.create_audio(blogName, caption="Mega rock out.", external_url="https://soundcloud.com/skrillex/sets/recess")
        
        Creating a video post
        '''''''''''''''''''''
        
        Creating a video post allows for all default options and has three other options. Like the other post types, it has some restrictions. You cannot use the embed and data parameters at the same time. \* **caption** - a string, the caption for your post \* **embed** - a string, the HTML embed code for the video \* **data** - a string, the path of the file you want to upload
        
        .. code:: python
        
            #Creating an upload from YouTube
            client.create_video(blogName, caption="Jon Snow. Mega ridiculous sword.",
                                embed="http://www.youtube.com/watch?v=40pUYLacrj4")
        
            #Creating a video post from local file
            client.create_video(blogName, caption="testing", data="/Users/johnb/testing/ok/blah.mov")
        
        Editing a post
        ^^^^^^^^^^^^^^
        
        Updating a post requires you knowing what type a post you're updating. You'll be able to supply to the post any of the options given above for updates.
        
        .. code:: python
        
            client.edit_post(blogName, id=post_id, type="text", title="Updated")
            client.edit_post(blogName, id=post_id, type="photo", data="/Users/johnb/mega/awesome.jpg")
        
        Reblogging a Post
        ^^^^^^^^^^^^^^^^^
        
        Reblogging a post just requires knowing the post id and the reblog key, which is supplied in the JSON of any post object.
        
        .. code:: python
        
            client.reblog(blogName, id=125356, reblog_key="reblog_key")
        
        Deleting a post
        ^^^^^^^^^^^^^^^
        
        Deleting just requires that you own the post and have the post id
        
        .. code:: python
        
            client.delete_post(blogName, 123456) # Deletes your post :(
        
        A note on tags: When passing tags, as params, please pass them as a list (not a comma-separated string):
        
        .. code:: python
        
            client.create_text(blogName, tags=['hello', 'world'], ...)
        
        Getting notes for a post
        ^^^^^^^^^^^^^^^^^^^^^^^^
        
        In order to get the notes for a post, you need to have the post id and the blog that it is on.
        
        .. code:: python
        
            data = client.notes(blogName, id='123456')
        
        The results include a timestamp you can use to make future calls.
        
        .. code:: python
        
            data = client.notes(blogName, id='123456', before_timestamp=data["_links"]["next"]["query_params"]["before_timestamp"])
        
        
        Tagged Methods
        ~~~~~~~~~~~~~~
        
        .. code:: python
        
            # get posts with a given tag
            client.tagged(tag, **params)
        
        Using the interactive console
        -----------------------------
        
        This client comes with a nice interactive console to run you through the OAuth process, grab your tokens (and store them for future use).
        
        You'll need ``pyyaml`` installed to run it, but then it's just:
        
        .. code:: bash
        
            $ python interactive-console.py
        
        and away you go! Tokens are stored in ``~/.tumblr`` and are also shared by other Tumblr API clients like the Ruby client.
        
        Running tests
        -------------
        
        The tests (and coverage reports) are run with nose, like this:
        
        .. code:: bash
        
            python setup.py test
        
        Copyright and license
        =====================
        
        Copyright 2013 Tumblr, Inc.
        
        Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
        
        http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations.
        
        .. |Build Status| image:: https://travis-ci.org/tumblr/pytumblr.png?branch=master
           :target: https://travis-ci.org/tumblr/pytumblr
        
Keywords: pytumblr
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
