pinterest-client modifications 2019-04-19

Motivation:

For me, it is not very convenient the way the Pinterest application shows the pins in mobile devices. The great feature of starting a visual search when you makes a zoom in an image, turns to be a bit unpleasant when you try to observe the image in detail. Also moving from one pin to another, sometimes, is not as comfortable as I would expect (specially browsing own pins).

I started to search the way to download all pins in a board and several options arise. I found pinterest-client with lot of functionalities, very interesting, in Python, easy to use... in fact a very good tool.

Even so the possibility of downloading all pins in a board was not possible. Also, it was not possible to use sections. So I decided to add some extra functionalities to this package.

I would like to thank the original author of pinterest-client: Cao Văn Hậu for the great job in doing the package pinterest-client.

I hope this extra features can help someone else.

Listed some modifications:

• some procedures adapted to Python 3
• modified address www.pinterest.com to www.pinterest.es as some redirection issues appeared
• Functionalities added to:
  • get all pins in a board from the logged user
  • get all section in a board from the logged user
  • get all pins in a section from the logged user
  • small routine to fetch all boards/sections/pins from the logged user

There are many things that could be done and, maybe, I will do.

NOTE: this fork IS NOT in pypi, so forget about the installation using pip as described bellow.

Following the comments from the original author of pinterest-client.

pinterest-client

A simple python client for Pinterest that support user interact with Pinterest such as simple browser.

Support operations: login, pin, save pin, delete pin, boards, create board, delete board, follow board, follow user, comment, search pins, search users, search boards.

Installation

This package is in pypi so you can install it easily using pip command:

pip install pinterest-client

or install from source code if you downloaded it from this GitHub repository by using command:

python setup.py install

Dependencies

This package depends on some other Python packages:

• requests
• requests_toolbelt

They are included in the requirements of this package so you won't have to manually install them.

Usage

After installation was successful, you can initialize a new pinterest object:

from pinterest import Pinterest

pinterest = Pinterest(username_or_email='your_username_or_email', password='your_password')

With proxies

If you need to use a proxy, you can pass proxies argument to constructor

from pinterest import Pinterest

proxies = {
    'http': 'http://10.10.1.10:3128',
    'https': 'http://10.10.1.10:1080',
}

pinterest = Pinterest(
    username_or_email='your_username_or_email', 
    password='your_password', 
    proxies=proxies)

Custom User-Agent

You can also use your custom User-Agent string for each pinterest-client object

from pinterest import Pinterest

agent_string='Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0'

pinterest = Pinterest(
    username_or_email='your_username_or_email', 
    password='your_password', 
    agent_string=agent_string)

Operations

from pinterest import Pinterest

pinterest = Pinterest(username_or_email='your_username_or_email', password='your_password')

# Login to pinterest site, if 'ok' return True otherwise return False
logged_in = pinterest.login()

# Get all boards of logged in user
boards = pinterest.boards()

# Create new board, it also return new board data if creation was successful
pinterest.create_board(name='Board name', description='Description')

# Follow a board
pinterest.follow_board(board_id='657384945546806337', board_url='/cvhautt/animal/')

# Follow a user
pinterest.follow_user(user_id='657385014266199005', username='cvhautt')

# Create pin from an image url
pin = pinterest.pin(
    board_id='657384945546806337', 
    image_url='your_image_url', 
    description='your_description (*optional)', 
    link='your_link (*optional)')

# Create pin by uploading an image from your computer
uploaded_pin = pinterest.upload_pin(
    board_id='657384945546806337', 
    image_file='full_path_to_your_image', 
    description='your_description (*optional)')

# Save a pin to your board (known as Save button on Pinterest site)
pinterest.repin(board_id='657385014266199005', pin_id='pin_id')

# Delete a pin
pinterest.delete_pin(pin_id='your_pin_id')

# Comment on a pin
cmt = pinterest.comment(pin_id='your_pin_id', text='your_comment_text')

# Delete a comment from pin
pinterest.delete_comment(pin_id='your_pin_id', comment_id='your_comment_id')

# Invite a person to join to your board
pinterest.invite(board_id='your_board_id', board_url='your_board_url', user_id='user_id')

# Search data on Pinterest site
boards = pinterest.search_boards(query='Some query')
pins = pinterest.search_pins(query='Some query')
users = pinterest.search_users(query='Some query')

# You can also get next page from search result by passing next_page=True to search operations above.
# Exp:
boards = pinterest.search_boards(query='Some query', next_page=True)
pins = pinterest.search_pins(query='Some query',next_page=True)