From 0d92a289b3586dd9aa4135248c2a56e8b0c5e049 Mon Sep 17 00:00:00 2001 From: Nikhil Raj Date: Sat, 18 May 2024 10:30:34 +0530 Subject: [PATCH] Updated documentation --- dev-documentation.md | 17 +++++++++++++++++ src/scrape_up/pinterest/pinterest.py | 8 ++++---- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/dev-documentation.md b/dev-documentation.md index 296eb212..4eae3a01 100644 --- a/dev-documentation.md +++ b/dev-documentation.md @@ -1745,3 +1745,20 @@ atcode.get_profile() | `.get_profile()` | Returns the user data in json format. | --- + +## Pinterest + +First create an object of class `Pinterest`. + +```python +from scrap_up import Pinterest + +pinterest = Pinterest() +``` + +| Methods | Details | +| --------------------------- | ------------------------------------------------------------ | +| `.get_today()` | Returns the list of today's topics | +| `.get_photo(your_url)` | Returns the link to the image (so you don't need an account) | +| `.search_pins(keyword)` | Search for pins containing a specific keyword on Pinterest | +| `.get_pin_details(pin_url)` | Fetch details about a specific pin on Pinterest | diff --git a/src/scrape_up/pinterest/pinterest.py b/src/scrape_up/pinterest/pinterest.py index 45d06639..ac54ffba 100644 --- a/src/scrape_up/pinterest/pinterest.py +++ b/src/scrape_up/pinterest/pinterest.py @@ -5,10 +5,10 @@ class Pinterest: """ Create an instance of `Pinterest` class. - ```python - pinterest = Pinterest() - ``` - | Methods | Details | + ```python + pinterest = Pinterest() + ``` + | Methods | Details | | ---------------------- | ------------------------------------------------------------------ | | `.get_today()` | Returns the list of today's topics | | `.get_photo(your_url)` | Returns the link to the image (so you don't need an account) |