🐉 spring cleaning

Author: ma2za

README.md

@@ -4,10 +4,25 @@
 
 This is an unofficial library providing a Python interface for [Substack](https://substack.com/).
 I am in no way affiliated with Substack. It works with
-Python versions from 3.8+.
+Python versions from 3.7+.
 
 # Installation
 
 You can install python-substack using:
 
-    $ pip install python-substack
+    $ pip install python-substack
+
+# Usage
+
+Set the following environment variables by creating a **.env** file:
+
+    PUBLICATION_URL=https://ma2za.substack.com
+    EMAIL=
+    PASSWORD=
+    USER_ID=
+
+The only way I found to discover the USER_ID is to inspect
+the payload to a **/drafts** request. Under the fields **draftBylines**
+or **postBylines** there is a subfield **user_id** or **id**
+
+The .env file will be ignored by git but always be careful.

examples/draft.yaml

@@ -20,4 +20,7 @@ body:
     content: "2)"
   5:
     type: "paragraph"
-    content: "Set the EMAIL, PASSWORD, PUBLICATION_URL and USER_ID environment variables."
+    content: "Set the EMAIL, PASSWORD, PUBLICATION_URL and USER_ID environment variables."
+  6:
+    type: "captionedImage"
+    src: "https://i.insider.com/602ee9d81a89f20019a377c6?width=1136&format=jpeg"

examples/publish_post.py

@@ -11,32 +11,35 @@
 
 if __name__ == "__main__":
 
-	parser = argparse.ArgumentParser()
-	parser.add_argument("-p", "--post", default="draft.yaml", required=True,
-	                    help="YAML file containing the post to publish.", type=str)
-	parser.add_argument("--publish", help="Publish the draft.", action="store_true")
-	args = parser.parse_args()
-
-	with open(args.post, "r") as fp:
-		post_data = yaml.safe_load(fp)
-
-	title = post_data.get("title", "")
-	subtitle = post_data.get("subtitle", "")
-	body = post_data.get("body", {})
-
-	api = Api(
-		email=os.getenv("EMAIL"),
-		password=os.getenv("PASSWORD"),
-		publication_url=os.getenv("PUBLICATION_URL"),
-	)
-
-	post = Post(title, subtitle, os.getenv("USER_ID"))
-	for _, item in body.items():
-		post.add(item)
-
-	draft = api.post_draft(post.get_draft())
-
-	if args.publish:
-		api.prepublish_draft(draft.get("id"))
-
-		api.publish_draft(draft.get("id"))
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-p", "--post", default="draft.yaml", required=False,
+                        help="YAML file containing the post to publish.", type=str)
+    parser.add_argument("--publish", help="Publish the draft.", action="store_true", default=False)
+    args = parser.parse_args()
+
+    with open(args.post, "r") as fp:
+        post_data = yaml.safe_load(fp)
+
+    title = post_data.get("title", "")
+    subtitle = post_data.get("subtitle", "")
+    body = post_data.get("body", {})
+
+    api = Api(
+        email=os.getenv("EMAIL"),
+        password=os.getenv("PASSWORD"),
+        publication_url=os.getenv("PUBLICATION_URL"),
+    )
+
+    post = Post(title, subtitle, os.getenv("USER_ID"))
+    for _, item in body.items():
+        if item.get("type") == "captionedImage":
+            image = api.get_image(item.get("src"))
+            item.update({"src": image.get("url")})
+        post.add(item)
+
+    draft = api.post_draft(post.get_draft())
+
+    if args.publish:
+        api.prepublish_draft(draft.get("id"))
+
+        api.publish_draft(draft.get("id"))

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-substack"
-version = "0.1.5"
+version = "0.1.6"
 description = "A Python wrapper around the Substack API."
 authors = ["Paolo Mazza <mazzapaolo2019@gmail.com>"]
 license = "MIT"
@@ -10,8 +10,8 @@ packages = [
 
 readme = "README.md"
 
-repository = "https://github.com/mazza8/python-substack"
-homepage = "https://github.com/mazza8/python-substack"
+repository = "https://github.com/ma2za/python-substack"
+homepage = "https://github.com/ma2za/python-substack"
 
 keywords = ["substack"]