| Name | PyTumblr JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | https://github.com/tumblr/pytumblr |
| Summary | A Python Tumblr API v2 Client |
| upload_time | 2023-01-18 16:18:50 |
| maintainer | |
| docs_url | None |
| author | Tumblr |
| requires_python | >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.* |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2013 Tumblr, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License 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 under the License. |
| keywords |
pytumblr
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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 -m build
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://github.com/tumblr/pytumblr/actions/workflows/ci.yaml/badge.svg
:target: https://github.com/tumblr/pytumblr/actions/workflows/ci.yaml
Raw data
{
"_id": null,
"home_page": "https://github.com/tumblr/pytumblr",
"name": "PyTumblr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"maintainer_email": "",
"keywords": "pytumblr",
"author": "Tumblr",
"author_email": "Tumblr <accounts@tumblr.com>",
"download_url": "https://files.pythonhosted.org/packages/e3/7c/f4002420a03bc367ee6ac58943b4968ae2cdfd690f1890e0c8cd75e53fbb/PyTumblr-0.1.2.tar.gz",
"platform": null,
"description": "PyTumblr\n========\n|Build Status|\n\nInstallation\n============\n\nInstall via pip:\n\n.. code-block:: bash\n\n $ pip install pytumblr\n\nInstall from source:\n\n.. code-block:: bash\n\n $ git clone https://github.com/tumblr/pytumblr.git\n $ cd pytumblr\n $ python -m build\n\nUsage\n=====\n\nCreate a client\n---------------\n\nA ``pytumblr.TumblrRestClient`` is the object you'll make all of your calls to the Tumblr API through. Creating one is this easy:\n\n.. code:: python\n\n client = pytumblr.TumblrRestClient(\n '<consumer_key>',\n '<consumer_secret>',\n '<oauth_token>',\n '<oauth_secret>',\n )\n\n client.info() # Grabs the current user information\n\nTwo easy ways to get your credentials to are:\n\n1. The built-in ``interactive_console.py`` tool (if you already have a consumer key & secret)\n2. The Tumblr API console at https://api.tumblr.com/console\n3. Get sample login code at https://api.tumblr.com/console/calls/user/info\n\nSupported Methods\n-----------------\n\nUser Methods\n~~~~~~~~~~~~\n\n.. code:: python\n\n client.info() # get information about the authenticating user\n client.dashboard() # get the dashboard for the authenticating user\n client.likes() # get the likes for the authenticating user\n client.following() # get the blogs followed by the authenticating user\n\n client.follow('codingjester.tumblr.com') # follow a blog\n client.unfollow('codingjester.tumblr.com') # unfollow a blog\n\n client.like(id, reblogkey) # like a post\n client.unlike(id, reblogkey) # unlike a post\n\nBlog Methods\n~~~~~~~~~~~~\n\n.. code:: python\n\n client.blog_info(blogName) # get information about a blog\n client.posts(blogName, **params) # get posts for a blog\n client.avatar(blogName) # get the avatar for a blog\n client.blog_likes(blogName) # get the likes on a blog\n client.followers(blogName) # get the followers of a blog\n client.blog_following(blogName) # get the publicly exposed blogs that [blogName] follows\n client.queue(blogName) # get the queue for a given blog\n client.submission(blogName) # get the submissions for a given blog\n\nPost Methods\n~~~~~~~~~~~~\n\nCreating posts\n^^^^^^^^^^^^^^\n\nPyTumblr 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.\n\nThe default supported types are described below.\n\n- **state** - a string, the state of the post. Supported types are *published*, *draft*, *queue*, *private*\n- **tags** - a list, a list of strings that you want tagged on the post. eg: [\"testing\", \"magic\", \"1\"]\n- **tweet** - a string, the string of the customized tweet you want. eg: \"Man I love my mega awesome post!\"\n- **date** - a string, the customized GMT that you want\n- **format** - a string, the format that your post is in. Support types are *html* or *markdown*\n- **slug** - a string, the slug for the url of the post you want\n\nWe'll show examples throughout of these default examples while showcasing all the specific post types.\n\nCreating a photo post\n'''''''''''''''''''''\n\nCreating 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\n\n.. code:: python\n\n #Creates a photo post using a source URL\n client.create_photo(blogName, state=\"published\", tags=[\"testing\", \"ok\"],\n source=\"https://68.media.tumblr.com/b965fbb2e501610a29d80ffb6fb3e1ad/tumblr_n55vdeTse11rn1906o1_500.jpg\")\n\n #Creates a photo post using a local filepath\n client.create_photo(blogName, state=\"queue\", tags=[\"testing\", \"ok\"],\n tweet=\"Woah this is an incredible sweet post [URL]\",\n data=\"/Users/johnb/path/to/my/image.jpg\")\n\n #Creates a photoset post using several local filepaths\n client.create_photo(blogName, state=\"draft\", tags=[\"jb is cool\"], format=\"markdown\",\n data=[\"/Users/johnb/path/to/my/image.jpg\", \"/Users/johnb/Pictures/kittens.jpg\"],\n caption=\"## Mega sweet kittens\")\n\nCreating a text post\n''''''''''''''''''''\n\nCreating 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\n\n.. code:: python\n\n #Creating a text post\n client.create_text(blogName, state=\"published\", slug=\"testing-text-posts\", title=\"Testing\", body=\"testing1 2 3 4\")\n\nCreating a quote post\n'''''''''''''''''''''\n\nCreating 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\n\n.. code:: python\n\n #Creating a quote post\n client.create_quote(blogName, state=\"queue\", quote=\"I am the Walrus\", source=\"Ringo\")\n\nCreating a link post\n''''''''''''''''''''\n\n- **title** - a string, the title of post that you want. Supports HTML entities.\n- **url** - a string, the url that you want to create a link post for.\n- **description** - a string, the desciption of the link that you have\n\n.. code:: python\n\n #Create a link post\n client.create_link(blogName, title=\"I like to search things, you should too.\", url=\"https://duckduckgo.com\",\n description=\"Search is pretty cool when a duck does it.\")\n\nCreating a chat post\n''''''''''''''''''''\n\nCreating 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)\n\n.. code:: python\n\n #Create a chat post\n chat = \"\"\"John: Testing can be fun!\n Renee: Testing is tedious and so are you.\n John: Aw.\n \"\"\"\n client.create_chat(blogName, title=\"Renee just doesn't understand.\", conversation=chat, tags=[\"renee\", \"testing\"])\n\nCreating an audio post\n''''''''''''''''''''''\n\nCreating 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\n\n.. code:: python\n\n #Creating an audio file\n client.create_audio(blogName, caption=\"Rock out.\", data=\"/Users/johnb/Music/my/new/sweet/album.mp3\")\n\n #lets use soundcloud!\n client.create_audio(blogName, caption=\"Mega rock out.\", external_url=\"https://soundcloud.com/skrillex/sets/recess\")\n\nCreating a video post\n'''''''''''''''''''''\n\nCreating 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\n\n.. code:: python\n\n #Creating an upload from YouTube\n client.create_video(blogName, caption=\"Jon Snow. Mega ridiculous sword.\",\n embed=\"http://www.youtube.com/watch?v=40pUYLacrj4\")\n\n #Creating a video post from local file\n client.create_video(blogName, caption=\"testing\", data=\"/Users/johnb/testing/ok/blah.mov\")\n\nEditing a post\n^^^^^^^^^^^^^^\n\nUpdating 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.\n\n.. code:: python\n\n client.edit_post(blogName, id=post_id, type=\"text\", title=\"Updated\")\n client.edit_post(blogName, id=post_id, type=\"photo\", data=\"/Users/johnb/mega/awesome.jpg\")\n\nReblogging a Post\n^^^^^^^^^^^^^^^^^\n\nReblogging a post just requires knowing the post id and the reblog key, which is supplied in the JSON of any post object.\n\n.. code:: python\n\n client.reblog(blogName, id=125356, reblog_key=\"reblog_key\")\n\nDeleting a post\n^^^^^^^^^^^^^^^\n\nDeleting just requires that you own the post and have the post id\n\n.. code:: python\n\n client.delete_post(blogName, 123456) # Deletes your post :(\n\nA note on tags: When passing tags, as params, please pass them as a list (not a comma-separated string):\n\n.. code:: python\n\n client.create_text(blogName, tags=['hello', 'world'], ...)\n\nGetting notes for a post\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nIn order to get the notes for a post, you need to have the post id and the blog that it is on.\n\n.. code:: python\n\n data = client.notes(blogName, id='123456')\n\nThe results include a timestamp you can use to make future calls.\n\n.. code:: python\n\n data = client.notes(blogName, id='123456', before_timestamp=data[\"_links\"][\"next\"][\"query_params\"][\"before_timestamp\"])\n\n\nTagged Methods\n~~~~~~~~~~~~~~\n\n.. code:: python\n\n # get posts with a given tag\n client.tagged(tag, **params)\n\nUsing the interactive console\n-----------------------------\n\nThis client comes with a nice interactive console to run you through the OAuth process, grab your tokens (and store them for future use).\n\nYou'll need ``pyyaml`` installed to run it, but then it's just:\n\n.. code:: bash\n\n $ python interactive_console.py\n\nand away you go! Tokens are stored in ``~/.tumblr`` and are also shared by other Tumblr API clients like the Ruby client.\n\nRunning tests\n-------------\n\nThe tests (and coverage reports) are run with nose, like this:\n\n.. code:: bash\n\n python setup.py test\n\nCopyright and license\n=====================\n\nCopyright 2013 Tumblr, Inc.\n\nLicensed 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:\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless 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.\n\n.. |Build Status| image:: https://github.com/tumblr/pytumblr/actions/workflows/ci.yaml/badge.svg\n :target: https://github.com/tumblr/pytumblr/actions/workflows/ci.yaml\n",
"bugtrack_url": null,
"license": " Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright 2013 Tumblr, Inc. Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License 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 under the License. ",
"summary": "A Python Tumblr API v2 Client",
"version": "0.1.2",
"split_keywords": [
"pytumblr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82fb4623b76a15f198aab85aa91a4bbc29e4cd1d52ed9dbd44f15e6af7dde4ce",
"md5": "0fa480e79c6b1ffc71ee07ec8c1e5705",
"sha256": "4435bf4ddbd3543a980a2920788914e8e41a9b91b255eabfd22dd7a2f4eedfec"
},
"downloads": -1,
"filename": "PyTumblr-0.1.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fa480e79c6b1ffc71ee07ec8c1e5705",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"size": 19083,
"upload_time": "2023-01-18T16:18:48",
"upload_time_iso_8601": "2023-01-18T16:18:48.862659Z",
"url": "https://files.pythonhosted.org/packages/82/fb/4623b76a15f198aab85aa91a4bbc29e4cd1d52ed9dbd44f15e6af7dde4ce/PyTumblr-0.1.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e37cf4002420a03bc367ee6ac58943b4968ae2cdfd690f1890e0c8cd75e53fbb",
"md5": "6d10c0492081ef580f5d1478d383f645",
"sha256": "eef2653110f84df74a9d8628a4edf30131004de07e93484bc8cc95e44072036e"
},
"downloads": -1,
"filename": "PyTumblr-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "6d10c0492081ef580f5d1478d383f645",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"size": 16655,
"upload_time": "2023-01-18T16:18:50",
"upload_time_iso_8601": "2023-01-18T16:18:50.992829Z",
"url": "https://files.pythonhosted.org/packages/e3/7c/f4002420a03bc367ee6ac58943b4968ae2cdfd690f1890e0c8cd75e53fbb/PyTumblr-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-18 16:18:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "tumblr",
"github_project": "pytumblr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pytumblr"
}
