Skip to content

support custom domains #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dorkamotorka wants to merge 1 commit into from
Closed

support custom domains #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions substack_api/newsletter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def get_newsletters_in_category(


def get_newsletter_post_metadata(
newsletter_subdomain: str,
newsletter_domain: str,
slugs_only: bool = False,
start_offset: int = None,
end_offset: int = None,
Expand All @@ -103,7 +103,7 @@ def get_newsletter_post_metadata(

Parameters
----------
newsletter_subdomain : Substack subdomain of newsletter
newsletter_domain : Substack domain of newsletter
slugs_only : Whether to return only post slugs (needed for post content collection)
start_page : Start page for paginated API results
end_page : End page for paginated API results
Expand All @@ -114,7 +114,7 @@ def get_newsletter_post_metadata(
last_id_ref = 0
all_posts = []
while offset_start < offset_end:
full_url = f"https://{newsletter_subdomain}.substack.com/api/v1/archive?sort=new&search=&offset={offset_start}&limit=10"
full_url = f"https://{newsletter_domain}/api/v1/archive?sort=new&search=&offset={offset_start}&limit=10"
posts = requests.get(full_url, headers=HEADERS, timeout=30).json()

if len(posts) == 0:
Expand All @@ -138,34 +138,34 @@ def get_newsletter_post_metadata(


def get_post_contents(
newsletter_subdomain: str, slug: str, html_only: bool = False
newsletter_domain: str, slug: str, html_only: bool = False
) -> Union[Dict, str]:
"""
Gets individual post metadata and contents

Parameters
----------
newsletter_subdomain : Substack subdomain of newsletter
newsletter_domain : Substack domain of newsletter
slug : Slug of post to retrieve (can be retrieved from `get_newsletter_post_metadata`)
html_only : Whether to get only HTML of body text, or all metadata/content
"""
endpoint = f"https://{newsletter_subdomain}.substack.com/api/v1/posts/{slug}"
endpoint = f"https://{newsletter_domain}/api/v1/posts/{slug}"
post_info = requests.get(endpoint, headers=HEADERS, timeout=30).json()
if html_only:
return post_info["body_html"]

return post_info


def get_newsletter_recommendations(newsletter_subdomain: str) -> List[Dict[str, str]]:
def get_newsletter_recommendations(newsletter_domain: str) -> List[Dict[str, str]]:
"""
Gets recommended newsletters for a given newsletter

Parameters
----------
newsletter_subdomain : Substack subdomain of newsletter
newsletter_domain : Substack domain of newsletter
"""
endpoint = f"https://{newsletter_subdomain}.substack.com/recommendations"
endpoint = f"https://{newsletter_domain}/recommendations"
r = requests.get(endpoint, headers=HEADERS, timeout=30)
recs = r.text
soup = BeautifulSoup(recs, "html.parser")
Expand Down
12 changes: 6 additions & 6 deletions tests/test_newsletter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def test_get_newsletter_post_metadata_slugs_only(self, mock_get):
{"id": 2, "slug": "post-2"},
]

result = get_newsletter_post_metadata("test_subdomain", slugs_only=True)
result = get_newsletter_post_metadata("test_subdomain.substack.com", slugs_only=True)
self.assertEqual(result, ["post-1", "post-2"])

@patch("requests.get")
Expand All @@ -29,7 +29,7 @@ def test_get_newsletter_post_metadata_all_metadata(self, mock_get):
{"id": 2, "slug": "post-2", "title": "Post 2"},
]

result = get_newsletter_post_metadata("test_subdomain", slugs_only=False)
result = get_newsletter_post_metadata("test_subdomain.substack.com", slugs_only=False)
self.assertEqual(
result,
[
Expand Down Expand Up @@ -62,7 +62,7 @@ def test_get_newsletter_post_metadata_pagination(self, mock_get):
]

result = get_newsletter_post_metadata(
"test_subdomain", slugs_only=True, start_offset=0, end_offset=20
"test_subdomain.substack.com", slugs_only=True, start_offset=0, end_offset=20
)
self.assertEqual(result, ["post-1", "post-2", "post-3", "post-4"])

Expand All @@ -71,7 +71,7 @@ def test_get_newsletter_post_metadata_no_posts(self, mock_get):
mock_get.return_value = Mock(ok=True)
mock_get.return_value.json.return_value = []

result = get_newsletter_post_metadata("test_subdomain")
result = get_newsletter_post_metadata("test_subdomain.substack.com")
self.assertEqual(result, [])


Expand Down Expand Up @@ -120,7 +120,7 @@ def test_get_post_contents_html_only(self, mock_get):
"body_html": "<html><body>Test post</body></html>"
}

result = get_post_contents("test_subdomain", "test_slug", html_only=True)
result = get_post_contents("test_subdomain.substack.com", "test_slug", html_only=True)
self.assertEqual(result, "<html><body>Test post</body></html>")

@patch("requests.get")
Expand All @@ -133,7 +133,7 @@ def test_get_post_contents_all_metadata(self, mock_get):
"date": "2022-01-01",
}

result = get_post_contents("test_subdomain", "test_slug", html_only=False)
result = get_post_contents("test_subdomain.substack.com", "test_slug", html_only=False)
self.assertEqual(
result,
{
Expand Down