ssky 0.1.0__tar.gz

ssky-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 simpleskyclient
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ssky-0.1.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.1
+Name: ssky
+Version: 0.1.0
+Summary: Simple bluesky client
+Home-page: https://github.com/simpleskyclient/ssky
+License: LICENSE
+Keywords: bluesky,client
+Author: SimpleSkyClient Project
+Author-email: simpleskypclient@gmail.com
+Requires-Python: >=3.12,<3.14
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: atproto (>=0.0.55,<0.0.56)
+Requires-Dist: beautifulsoup4 (>=4.12.3,<5.0.0)
+Requires-Dist: pytest (>=8.3.4,<9.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Project-URL: Repository, https://github.com/simpleskyclient/ssky
+Description-Content-Type: text/markdown
+
+# ssky - Simple Bluesky client
+
+## Introduction
+
+Ssky is a simple Bluesky client, providing some specific features.
+
+* Simple but Linux shell friendly user interface
+  * You can give `URI` or `URI::CID` to retrieve (get), quote, reply-to, repost/unrepost and delete a unique post
+  * You can give `DID` or `handle` to retrieve timeline/posts/profile, follow/unfollow a unique user
+  * You can get simply 'URI:CID' for posts and 'DID' for users when you retrieve (get) them, so you can use them for Linux pipeline or command substitution
+  * Various output options:
+    * Only unique identifier such as `URI::CID` or `DID`, for Linux pipeline or command substitution ([See Samples](#samples) )
+    * Line oriented output with identifier and human friendly text, for listing many records
+    * Multiline output with full texts of some attributes, for reading details
+    * JSON output, for preserving record structure derived from atproto library
+    * Some subcommands such as `get` and `search` allow to output to files per records
+
+### Requirements
+
+* Python 3.12 or later
+
+### Install from github repository
+
+```bash
+pip install git+https://github.com/simpleskyclient/ssky.git
+```
+
+## Quick Start
+
+Ssky's behavior is specified by subcommand and options like `ssky subcommand [options]`.
+
+### Common options and names
+
+* Common option -D, --delimiter: Delimiter string in output
+* Common option -I, --id: Identifier only such as `URI::CID` or `DID`, depending on context
+* Common option -T, --text: Text only such as main text in post or description in user profile
+* Common option -L, --long: Long output
+* Common option -J, --json: JSON output
+* Common option -N NUM, --limit NUM: MAX result counts
+* Common option -O DIR, --output DIR: Output to files in the specified directory
+* Common name "myself": replace with login user DID or handle automatically
+
+### Login bluesky
+
+First or all, you must log in the Bluesky.
+
+```sh
+ssky login handle password
+```
+
+*Handle* and *password* are formatted like `xxxx.bsky.social` and `xxxx-xxxxx-xxxx-xxxx`, respectively.
+
+Once you have logged in, ssky remembers the login session in local environment (`~/.ssky`).
+However, you must log in again when ssky reports session timeout error like "400 Token has been revoked".
+
+You can also set Bluesky handle and password in environment variable `SSKY_USER`, separated by ':' like `handle:password`.
+
+```sh
+export SSKY_USER=user.bsky.social:xxxx-xxxxx-xxxx-xxxx
+```
+
+The environment variable overrides command line arguments, so you will login by the user alpha in the following example.
+
+```sh
+SSKY_USER=alpha:password1 ssky login bravo password2
+```
+
+### Get posts
+
+Get subcommand retrieves your timeline, another author's feed by handle or `DID`, and a post by `URI` or `URI::CID`.
+
+```sh
+ssky get # Get your timeline
+ssky get handle # Get other author's feed by handle, such as user.bsky.social
+ssky get did:... # Get other author's feed by DID
+ssky get at://... # Get a post specified by URI
+```
+
+### Get profile
+
+Profile subcommand retrieves the user profile from handle or display name.
+
+```sh
+ssky profile user.bsky.social
+ssky profile 'Display Name'
+```
+
+### Post
+
+Post subcommand sends a post. You can give the message by command line argument or the standard input.  Tags, link cards, mentions, quotations, reply-to and attached images are available.
+
+```sh
+ssky post Hello # Post from command line text
+echo Hello | ssky post # Post from /dev/stdin
+ssky post 'Hello, #bluesky @atproto.com https://bsky.app/' # Post with tags, mentions, and embed link card
+ssky post 'Hello, bluesky!' --image dir1/hello1.png --image dir2/hello2.png # Post with images
+ssky post 'Hello, bluesky!' --quote at://... # Quote the post
+ssky post 'Hello, bluesky!' --reply-to at://... # Reply to the post
+
+ssky post Hello --dry # Dry run
+```
+
+### Search posts
+
+Search subcommand searches posts.
+
+```sh
+ssky search foo # Search posts including 'foo'
+ssky search foo --author handle # Search posts including 'foo' by the specified author
+ssky search foo --since 20240101 --until 20241231 # Search posts including 'foo' in  the specified period
+```
+
+### Delete post
+
+Delete subcommand deletes a post.
+
+```sh
+ssky delete at://... # Delete the post
+```
+
+### Repost to post
+
+Repost subcommand reposts the post.
+
+```sh
+ssky repost at://... # Repost the post
+```
+
+### Unrepost to post
+
+Repost subcommand deletes the repost to a post.
+
+```sh
+ssky unrepost at://... # Delete your repost to the specified post
+```
+
+### Search users
+
+User subcommand searches users.
+
+```sh
+ssky user foo # Search users including 'foo' in handle name and description
+```
+
+### Follow user
+
+Follow subcommand follows a user.
+
+```sh
+ssky follow handle # Follow the user
+ssky follow did:.. # Follow the user
+```
+
+### Unfollow user
+
+Unfollow subcommand deletes the follow to the user.
+
+```sh
+ssky unfollow handle # Unfollow the user
+ssky unfollow did:.. # Unfollow the user
+```
+
+## Samples
+
+### Search keyword 'bluesky' in your posts
+
+```sh
+ssky search bluesky --author myself
+```
+
+### Save your last post in the directory './log'
+
+```sh
+ssky post 'My very important posted message'
+ssky get myself --limit 1 --text --output ./log
+```
+
+### Reply to the last post by myself
+
+```sh
+ssky post 'Reply!' --reply-to $(ssky get myself --limit 1 --id)
+```
+
+## License
+
+[MIT License](LICENSE)
+
+## Author
+
+[SimpleSkyClient Project](https://github.com/simpleskyclient)
+

ssky-0.1.0/README.md

@@ -0,0 +1,190 @@
+# ssky - Simple Bluesky client
+
+## Introduction
+
+Ssky is a simple Bluesky client, providing some specific features.
+
+* Simple but Linux shell friendly user interface
+  * You can give `URI` or `URI::CID` to retrieve (get), quote, reply-to, repost/unrepost and delete a unique post
+  * You can give `DID` or `handle` to retrieve timeline/posts/profile, follow/unfollow a unique user
+  * You can get simply 'URI:CID' for posts and 'DID' for users when you retrieve (get) them, so you can use them for Linux pipeline or command substitution
+  * Various output options:
+    * Only unique identifier such as `URI::CID` or `DID`, for Linux pipeline or command substitution ([See Samples](#samples) )
+    * Line oriented output with identifier and human friendly text, for listing many records
+    * Multiline output with full texts of some attributes, for reading details
+    * JSON output, for preserving record structure derived from atproto library
+    * Some subcommands such as `get` and `search` allow to output to files per records
+
+### Requirements
+
+* Python 3.12 or later
+
+### Install from github repository
+
+```bash
+pip install git+https://github.com/simpleskyclient/ssky.git
+```
+
+## Quick Start
+
+Ssky's behavior is specified by subcommand and options like `ssky subcommand [options]`.
+
+### Common options and names
+
+* Common option -D, --delimiter: Delimiter string in output
+* Common option -I, --id: Identifier only such as `URI::CID` or `DID`, depending on context
+* Common option -T, --text: Text only such as main text in post or description in user profile
+* Common option -L, --long: Long output
+* Common option -J, --json: JSON output
+* Common option -N NUM, --limit NUM: MAX result counts
+* Common option -O DIR, --output DIR: Output to files in the specified directory
+* Common name "myself": replace with login user DID or handle automatically
+
+### Login bluesky
+
+First or all, you must log in the Bluesky.
+
+```sh
+ssky login handle password
+```
+
+*Handle* and *password* are formatted like `xxxx.bsky.social` and `xxxx-xxxxx-xxxx-xxxx`, respectively.
+
+Once you have logged in, ssky remembers the login session in local environment (`~/.ssky`).
+However, you must log in again when ssky reports session timeout error like "400 Token has been revoked".
+
+You can also set Bluesky handle and password in environment variable `SSKY_USER`, separated by ':' like `handle:password`.
+
+```sh
+export SSKY_USER=user.bsky.social:xxxx-xxxxx-xxxx-xxxx
+```
+
+The environment variable overrides command line arguments, so you will login by the user alpha in the following example.
+
+```sh
+SSKY_USER=alpha:password1 ssky login bravo password2
+```
+
+### Get posts
+
+Get subcommand retrieves your timeline, another author's feed by handle or `DID`, and a post by `URI` or `URI::CID`.
+
+```sh
+ssky get # Get your timeline
+ssky get handle # Get other author's feed by handle, such as user.bsky.social
+ssky get did:... # Get other author's feed by DID
+ssky get at://... # Get a post specified by URI
+```
+
+### Get profile
+
+Profile subcommand retrieves the user profile from handle or display name.
+
+```sh
+ssky profile user.bsky.social
+ssky profile 'Display Name'
+```
+
+### Post
+
+Post subcommand sends a post. You can give the message by command line argument or the standard input.  Tags, link cards, mentions, quotations, reply-to and attached images are available.
+
+```sh
+ssky post Hello # Post from command line text
+echo Hello | ssky post # Post from /dev/stdin
+ssky post 'Hello, #bluesky @atproto.com https://bsky.app/' # Post with tags, mentions, and embed link card
+ssky post 'Hello, bluesky!' --image dir1/hello1.png --image dir2/hello2.png # Post with images
+ssky post 'Hello, bluesky!' --quote at://... # Quote the post
+ssky post 'Hello, bluesky!' --reply-to at://... # Reply to the post
+
+ssky post Hello --dry # Dry run
+```
+
+### Search posts
+
+Search subcommand searches posts.
+
+```sh
+ssky search foo # Search posts including 'foo'
+ssky search foo --author handle # Search posts including 'foo' by the specified author
+ssky search foo --since 20240101 --until 20241231 # Search posts including 'foo' in  the specified period
+```
+
+### Delete post
+
+Delete subcommand deletes a post.
+
+```sh
+ssky delete at://... # Delete the post
+```
+
+### Repost to post
+
+Repost subcommand reposts the post.
+
+```sh
+ssky repost at://... # Repost the post
+```
+
+### Unrepost to post
+
+Repost subcommand deletes the repost to a post.
+
+```sh
+ssky unrepost at://... # Delete your repost to the specified post
+```
+
+### Search users
+
+User subcommand searches users.
+
+```sh
+ssky user foo # Search users including 'foo' in handle name and description
+```
+
+### Follow user
+
+Follow subcommand follows a user.
+
+```sh
+ssky follow handle # Follow the user
+ssky follow did:.. # Follow the user
+```
+
+### Unfollow user
+
+Unfollow subcommand deletes the follow to the user.
+
+```sh
+ssky unfollow handle # Unfollow the user
+ssky unfollow did:.. # Unfollow the user
+```
+
+## Samples
+
+### Search keyword 'bluesky' in your posts
+
+```sh
+ssky search bluesky --author myself
+```
+
+### Save your last post in the directory './log'
+
+```sh
+ssky post 'My very important posted message'
+ssky get myself --limit 1 --text --output ./log
+```
+
+### Reply to the last post by myself
+
+```sh
+ssky post 'Reply!' --reply-to $(ssky get myself --limit 1 --id)
+```
+
+## License
+
+[MIT License](LICENSE)
+
+## Author
+
+[SimpleSkyClient Project](https://github.com/simpleskyclient)

ssky-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "ssky"
+version = "0.1.0"
+description = "Simple bluesky client"
+authors = ["SimpleSkyClient Project <simpleskypclient@gmail.com>"]
+readme = "README.md"
+license = "LICENSE"
+homepage = "https://github.com/simpleskyclient/ssky"
+repository = "https://github.com/simpleskyclient/ssky"
+keywords = ["bluesky", "client"]
+packages = [{include = "ssky", from = "src"}]
+
+[tool.poetry.dependencies]
+python = ">=3.12,<3.14"
+beautifulsoup4 = "^4.12.3"
+python-dotenv = "^1.0.1"
+requests = "^2.32.3"
+atproto = "^0.0.55"
+pytest = "^8.3.4"
+
+[tool.poetry.scripts]
+ssky = "ssky.main:main"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

ssky-0.1.0/src/ssky/delete.py

@@ -0,0 +1,25 @@
+import sys
+import atproto_client
+from ssky.ssky_session import ssky_client
+from ssky.util import disjoin_uri_cid, is_joined_uri_cid
+
+def delete(post, **kwargs) -> str:
+    if is_joined_uri_cid(post):
+        uri, _ = disjoin_uri_cid(post)
+    else:
+        uri = post
+
+    try:
+        status = ssky_client().delete_post(uri)
+        if status is False:
+            print('Failed to delete', file=sys.stderr)
+            return None
+        return uri
+    except atproto_client.exceptions.AtProtocolError as e:
+        if 'response' in dir(e) and e.response is not None:
+            print(f'{e.response.status_code} {e.response.content.message}', file=sys.stderr)
+        elif str(e) is not None and len(str(e)) > 0:
+            print(f'{str(e)}', file=sys.stderr)
+        else:
+            print(f'{e.__class__.__name__}', file=sys.stderr)
+        return None

ssky-0.1.0/src/ssky/follow.py

@@ -0,0 +1,20 @@
+import sys
+import atproto_client
+from ssky.profile_list import ProfileList
+from ssky.ssky_session import expand_actor, ssky_client
+
+def follow(name, **kwargs) -> str:
+    try:
+        client = ssky_client()
+        actor = expand_actor(name)
+        profile = client.get_profile(actor)
+        client.follow(profile.did)
+        return ProfileList().append(profile.did)
+    except atproto_client.exceptions.AtProtocolError as e:
+        if 'response' in dir(e) and e.response is not None:
+            print(f'{e.response.status_code} {e.response.content.message}', file=sys.stderr)
+        elif str(e) is not None and len(str(e)) > 0:
+            print(f'{str(e)}', file=sys.stderr)
+        else:
+            print(f'{e.__class__.__name__}', file=sys.stderr)
+        return None

ssky-0.1.0/src/ssky/get.py

@@ -0,0 +1,54 @@
+import sys
+import atproto_client
+from ssky.ssky_session import expand_actor, ssky_client
+from ssky.post_data_list import PostDataList
+from ssky.util import disjoin_uri_cid, is_joined_uri_cid
+
+def get_posts(client, uri, cid) -> None:
+    res = client.get_posts([uri])
+    post_data_list = PostDataList()
+    for post in res.posts:
+        if post.uri == uri and (cid is None or post.cid == cid):
+            post_data_list.append(post)
+    return post_data_list
+
+def get_author_feed(client, user, limit=100) -> None:
+    res = client.get_author_feed(user, limit=limit)
+    post_data_list = PostDataList()
+    for feed_post in res.feed:
+        post_data_list.append(feed_post.post)
+    return post_data_list
+
+def get_timeline(client, limit=100) -> None:
+    res = client.get_timeline(limit=limit)
+    post_data_list = PostDataList()
+    for feed_post in res.feed:
+        post_data_list.append(feed_post.post)
+    return post_data_list
+
+def get(target=None, limit=100, **kwargs) -> PostDataList:
+    try:
+        client = ssky_client()
+        if target is None:
+            post_data_list = get_timeline(client, limit=limit)
+        elif target.startswith('at://'):
+            if is_joined_uri_cid(target):
+                uri, cid = disjoin_uri_cid(target)
+            else:
+                uri = target
+                cid = None
+            post_data_list = get_posts(client, uri, cid)
+        elif target.startswith('did:'):
+            post_data_list = get_author_feed(client, target, limit=limit)
+        else:
+            actor = expand_actor(target)
+            post_data_list = get_author_feed(client, actor, limit=limit)
+        return post_data_list
+    except atproto_client.exceptions.AtProtocolError as e:
+        if 'response' in dir(e) and e.response is not None:
+            print(f'{e.response.status_code} {e.response.content.message}', file=sys.stderr)
+        elif str(e) is not None and len(str(e)) > 0:
+            print(f'{str(e)}', file=sys.stderr)
+        else:
+            print(f'{e.__class__.__name__}', file=sys.stderr)
+        return None

ssky-0.1.0/src/ssky/login.py

@@ -0,0 +1,18 @@
+import sys
+import atproto_client
+from ssky.profile_list import ProfileList
+from ssky.ssky_session import SskySession
+
+def login(handle=None, password=None, **kwargs) -> list:
+    try:
+        session = SskySession(handle=handle, password=password)
+        session.persist()
+        return ProfileList().append(session.profile().did)
+    except atproto_client.exceptions.AtProtocolError as e:
+        if 'response' in dir(e) and e.response is not None:
+            print(f'{e.response.status_code} {e.response.content.message}', file=sys.stderr)
+        elif str(e) is not None and len(str(e)) > 0:
+            print(f'{str(e)}', file=sys.stderr)
+        else:
+            print(f'{e.__class__.__name__}', file=sys.stderr)
+        return None