python-substack 0.1.14__tar.gz → 0.1.16__tar.gz

{python_substack-0.1.14 → python_substack-0.1.16}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-substack
-Version: 0.1.14
+Version: 0.1.16
 Summary: A Python wrapper around the Substack API.
-Home-page: https://github.com/ma2za/python-substack
 License: MIT
+License-File: LICENSE
 Keywords: substack
 Author: Paolo Mazza
 Author-email: mazzapaolo2019@gmail.com
@@ -16,9 +16,12 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: PyYAML (>=6.0,<7.0)
 Requires-Dist: python-dotenv (>=0.21.0,<0.22.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
+Project-URL: Homepage, https://github.com/ma2za/python-substack
 Project-URL: Repository, https://github.com/ma2za/python-substack
 Description-Content-Type: text/markdown
 
@@ -46,16 +49,19 @@ Set the following environment variables by creating a **.env** file:
 
     EMAIL=
     PASSWORD=
+    PUBLICATION_URL=  # Optional: your publication URL
+    COOKIES_PATH=     # Optional: path to cookies JSON file
+    COOKIES_STRING=   # Optional: cookie string for authentication
 
 ## If you don't have a password
 
-Recently Substack has been setting up new accounts without a password. If you sign-out and sign back in it just uses
+Recently Substack has been setting up new accounts without a password. If you sign out and sign back in, it just uses
 your email address with a "magic" link.
 
 Set a password:
 
-- Sign-out of Substack
-- At the sign-in page click, "Sign in with password" under the `Email` text box
+- Sign out of Substack
+- At the sign-in page, click "Sign in with password" under the `Email` text box
 - Then choose, "Set a new password"
 
 The .env file will be ignored by git but always be careful.
@@ -75,11 +81,12 @@ from substack.post import Post
 api = Api(
     email=os.getenv("EMAIL"),
     password=os.getenv("PASSWORD"),
+    publication_url=os.getenv("PUBLICATION_URL"),
 )
 
 user_id = api.get_user_id()
 
-# Switch Publications - The library defaults to your users primary publication. You can retrieve all your publications and change which one you want to use.
+# Switch Publications - The library defaults to your user's primary publication. You can retrieve all your publications and change which one you want to use.
 
 # primary publication
 user_publication = api.get_user_primary_publication()
@@ -116,11 +123,15 @@ post.add({'type': 'captionedImage', 'src': "https://media.tenor.com/7B4jMa-a7bsA
 image = api.get_image('image.png')
 post.add({"type": "captionedImage", "src": image.get("url")})
 
+# embed publication
+embedded = api.publication_embed("https://jackio.substack.com/")
+post.add({"type": "embeddedPublication", "url": embedded})
+
 draft = api.post_draft(post.get_draft())
 
-# set section (THIS CAN BE DONE ONLY AFTER HAVING FIRST POSTED THE DRAFT)
-post.set_section("rick rolling", api.get_sections())
-api.put_draft(draft.get("id"), draft_section_id=post.draft_section_id)
+# set section (can only be done after first posting the draft)
+# post.set_section("rick rolling", api.get_sections())
+# api.put_draft(draft.get("id"), draft_section_id=post.draft_section_id)
 
 api.prepublish_draft(draft.get("id"))
 
@@ -141,3 +152,7 @@ Set up pre-commit
 pre-commit install
 ```
 
+## Cookie Help
+
+To get a cookie string, after login, go to dev tools (F12), network tab, refresh and find one of the requests like subscription/unred/subscriptions, right click and copy as fetch (Node.js), paste somewhere and get the entire cookie string assigned to the cookie header and put it in the env variables as COOKIES_STRING, et voila!
+

{python_substack-0.1.14 → python_substack-0.1.16}/README.md

@@ -22,16 +22,19 @@ Set the following environment variables by creating a **.env** file:
 
     EMAIL=
     PASSWORD=
+    PUBLICATION_URL=  # Optional: your publication URL
+    COOKIES_PATH=     # Optional: path to cookies JSON file
+    COOKIES_STRING=   # Optional: cookie string for authentication
 
 ## If you don't have a password
 
-Recently Substack has been setting up new accounts without a password. If you sign-out and sign back in it just uses
+Recently Substack has been setting up new accounts without a password. If you sign out and sign back in, it just uses
 your email address with a "magic" link.
 
 Set a password:
 
-- Sign-out of Substack
-- At the sign-in page click, "Sign in with password" under the `Email` text box
+- Sign out of Substack
+- At the sign-in page, click "Sign in with password" under the `Email` text box
 - Then choose, "Set a new password"
 
 The .env file will be ignored by git but always be careful.
@@ -51,11 +54,12 @@ from substack.post import Post
 api = Api(
     email=os.getenv("EMAIL"),
     password=os.getenv("PASSWORD"),
+    publication_url=os.getenv("PUBLICATION_URL"),
 )
 
 user_id = api.get_user_id()
 
-# Switch Publications - The library defaults to your users primary publication. You can retrieve all your publications and change which one you want to use.
+# Switch Publications - The library defaults to your user's primary publication. You can retrieve all your publications and change which one you want to use.
 
 # primary publication
 user_publication = api.get_user_primary_publication()
@@ -92,11 +96,15 @@ post.add({'type': 'captionedImage', 'src': "https://media.tenor.com/7B4jMa-a7bsA
 image = api.get_image('image.png')
 post.add({"type": "captionedImage", "src": image.get("url")})
 
+# embed publication
+embedded = api.publication_embed("https://jackio.substack.com/")
+post.add({"type": "embeddedPublication", "url": embedded})
+
 draft = api.post_draft(post.get_draft())
 
-# set section (THIS CAN BE DONE ONLY AFTER HAVING FIRST POSTED THE DRAFT)
-post.set_section("rick rolling", api.get_sections())
-api.put_draft(draft.get("id"), draft_section_id=post.draft_section_id)
+# set section (can only be done after first posting the draft)
+# post.set_section("rick rolling", api.get_sections())
+# api.put_draft(draft.get("id"), draft_section_id=post.draft_section_id)
 
 api.prepublish_draft(draft.get("id"))
 
@@ -116,3 +124,7 @@ Set up pre-commit
 ```shell
 pre-commit install
 ```
+
+## Cookie Help
+
+To get a cookie string, after login, go to dev tools (F12), network tab, refresh and find one of the requests like subscription/unred/subscriptions, right click and copy as fetch (Node.js), paste somewhere and get the entire cookie string assigned to the cookie header and put it in the env variables as COOKIES_STRING, et voila!

{python_substack-0.1.14 → python_substack-0.1.16}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-substack"
-version = "0.1.14"
+version = "0.1.16"
 description = "A Python wrapper around the Substack API."
 authors = ["Paolo Mazza <mazzapaolo2019@gmail.com>"]
 license = "MIT"
@@ -23,7 +23,7 @@ python-dotenv = "^0.21.0"
 PyYAML = "^6.0"
 
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 
 
 [build-system]

{python_substack-0.1.14 → python_substack-0.1.16}/substack/api.py

@@ -9,7 +9,7 @@ import json
 import logging
 import os
 from datetime import datetime
-from urllib.parse import urljoin
+from urllib.parse import urljoin, unquote
 
 import requests
 
@@ -35,6 +35,7 @@ class Api:
         base_url=None,
         publication_url=None,
         debug=False,
+        cookies_string=None,
     ):
         """
 
@@ -49,6 +50,10 @@ class Api:
             To re-use your session without logging in each time, you can save your cookies to a json file and
             then load them in the next session.
             Make sure to re-save your cookies, as they do update over time.
+          cookies_string
+            To re-use your session without logging in each time, you can provide cookies as a semicolon-separated
+            string (e.g., "cookie1=value1; cookie2=value2"). This is useful when copying cookies from browser
+            developer tools.
           base_url:
             The base URL to use to contact the Substack API.
             Defaults to https://substack.com/api/v1.
@@ -68,11 +73,15 @@ class Api:
                 cookies = json.load(f)
             self._session.cookies.update(cookies)
 
+        elif cookies_string is not None:
+            cookies = self._parse_cookies_string(cookies_string)
+            self._session.cookies.update(cookies)
+
         elif email is not None and password is not None:
             self.login(email, password)
         else:
             raise ValueError(
-                "Must provide email and password or cookies_path to authenticate."
+                "Must provide email and password, cookies_path, or cookies_string to authenticate."
             )
 
         user_publication = None
@@ -98,6 +107,31 @@ class Api:
         # set the current publication to the users primary publication
         self.change_publication(user_publication)
 
+    @staticmethod
+    def _parse_cookies_string(cookies_string: str) -> dict:
+        """
+        Parse a semicolon-separated cookie string into a dictionary.
+        
+        Args:
+            cookies_string: A semicolon-separated string of cookies (e.g., "cookie1=value1; cookie2=value2")
+            
+        Returns:
+            A dictionary of cookie name-value pairs
+        """
+        cookies = {}
+        for cookie_pair in cookies_string.split(';'):
+            cookie_pair = cookie_pair.strip()
+            if not cookie_pair:
+                continue
+            if '=' in cookie_pair:
+                key, value = cookie_pair.split('=', 1)
+                key = key.strip()
+                value = value.strip()
+                # URL decode the value (e.g., s%3A becomes s:)
+                value = unquote(value)
+                cookies[key] = value
+        return cookies
+
     def login(self, email, password) -> dict:
         """
 
@@ -128,7 +162,11 @@ class Api:
         response = self._session.get(
             f"https://substack.com/sign-in?redirect=%2F&for_pub={publication['subdomain']}",
         )
-        return Api._handle_response(response=response)
+        try:
+            output = Api._handle_response(response=response)
+        except SubstackRequestException as ex:
+            output = {}
+        return output
 
     def change_publication(self, publication):
         """
@@ -185,8 +223,8 @@ class Api:
         Args:
             publication:
         """
-        custom_domain = publication["custom_domain"]
-        if not custom_domain:
+        custom_domain = publication.get("custom_domain", None)
+        if not custom_domain and not publication.get('custom_domain_optional', None):
             publication_url = f"https://{publication['subdomain']}.substack.com"
         else:
             publication_url = f"https://{custom_domain}"
@@ -199,7 +237,31 @@ class Api:
         """
 
         profile = self.get_user_profile()
-        primary_publication = profile["primaryPublication"]
+        primary_publication = None
+        
+        # Try old API format first (backward compatibility)
+        if "primaryPublication" in profile and profile["primaryPublication"] is not None:
+            primary_publication = profile["primaryPublication"]
+        else:
+            # New API format: look for primary publication in publicationUsers
+            publication_users = profile.get("publicationUsers")
+            if publication_users is not None and len(publication_users) > 0:
+                # Find the publication where is_primary is True
+                for pub_user in publication_users:
+                    if pub_user.get("is_primary", False):
+                        primary_publication = pub_user.get("publication")
+                        if primary_publication:
+                            break
+                
+                # If no primary found, use the first publication
+                if primary_publication is None:
+                    primary_publication = publication_users[0].get("publication")
+        
+        if primary_publication is None:
+            raise SubstackRequestException(
+                "Could not find primary publication in profile"
+            )
+            
         primary_publication["publication_url"] = self.get_publication_url(
             primary_publication
         )
@@ -216,10 +278,18 @@ class Api:
         # Loop through users "publicationUsers" list, and return a list
         # of dictionaries of "name", and "subdomain", and "id"
         user_publications = []
-        for publication in profile["publicationUsers"]:
-            pub = publication["publication"]
-            pub["publication_url"] = self.get_publication_url(pub)
-            user_publications.append(pub)
+        publication_users = profile.get("publicationUsers")
+        
+        if publication_users is None:
+            # If publicationUsers is None, return empty list or try to construct from other fields
+            # This maintains backward compatibility while handling new API format
+            return user_publications
+        
+        for publication in publication_users:
+            pub = publication.get("publication")
+            if pub is not None:
+                pub["publication_url"] = self.get_publication_url(pub)
+                user_publications.append(pub)
 
         return user_publications
 
@@ -538,3 +608,32 @@ class Api:
             if p.get("hostname") in self.publication_url
         ]
         return sections[0]
+
+    def publication_embed(self, url):
+        """
+
+        Args:
+            url:
+
+        Returns:
+
+        """
+        return self.call("/publication/embed", "GET", url=url)
+
+    def call(self, endpoint, method, **params):
+        """
+
+        Args:
+            endpoint:
+            method:
+            **params:
+
+        Returns:
+
+        """
+        response = self._session.request(
+            method=method,
+            url=f"{self.publication_url}/{endpoint}",
+            params=params,
+        )
+        return Api._handle_response(response=response)

{python_substack-0.1.14 → python_substack-0.1.16}/substack/post.py

@@ -84,6 +84,8 @@ class Post:
         content = item.get("content")
         if item.get("type") == "captionedImage":
             self.captioned_image(**item)
+        elif item.get("type") == "embeddedPublication":
+            self.draft_body["content"][-1]["attrs"] = item.get("url")
         elif item.get("type") == "youtube2":
             self.youtube(item.get("src"))
         elif item.get("type") == "subscribeWidget":