Metadata-Version: 2.4
Name: skyter
Version: 0.1.3
Summary: TUI for Bsky
Author-email: Hudson Bailey <dev@hudsonbailey.org>
License: MIT License
        
        Copyright (c) 2025 Hudson Bailey
        
        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.
        
Project-URL: Homepage, https://github.com/hdb/skyter
Project-URL: Bug Tracker, https://github.com/hdb/skyter/issues
Project-URL: Documentation, https://skyter.readthedocs.io
Keywords: atproto,bsky,bluesky,textual,tui
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Communications
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: atproto>=0.0.61
Requires-Dist: pyperclip>=1.9.0
Requires-Dist: textual>=5.2.0
Requires-Dist: pyfiglet>=1.0.3
Requires-Dist: textual-fspicker>=0.4.1
Requires-Dist: beautifulsoup4>=4.13.4
Requires-Dist: aiohttp>=3.12.13

# skyter

skyter is a Bluesky client for the terminal built using [atproto](https://github.com/MarshalX/atproto) and [textual](https://github.com/Textualize/textual). Pronounce it however you prefer.

Features:

- View likes of other users
- Optionally hide post and user metrics
- Option for feeds to automatically update with new posts
- Pause/resume notifications
- Run multiple instances of skyter in terminal multiplexer for tweetdeck-like set-up

Not yet supported:

- DMs
- Bookmarks
- Thread composing
- Saving post drafts
- List / starter pack management
- Post interaction settings
- Bluesky settings (other than saved feeds)


## Requirements

- Python 3.8+
- xclip (if on Linux)

### Optional dependencies

- [python-dotenv](https://github.com/theskumar/python-dotenv): run `pip install python-dotenv` if you want to use an `.env` file for credentials
- textual's prepackaged tree-sitter binaries for json syntax highlighting: run `pip install "textual[syntax]"`
- terminal media viewers such as [feh](https://feh.finalrewind.org/) or [mpv](https://mpv.io/) are recommended for opening post media

## Install

`pip install skyter`

## Set-up

- Optional but strongly recommended: create an [app password](https://bsky.app/settings/app-passwords) in the web client or app. You do not need to allow access to direct messages, as DMs are not yet supported. Password login is not supported for 2FA-enabled accounts
- Optionally set `BSKY_LOGIN` and `BSKY_APP_PASSWORD` (and `BSKY_PDS`, if using an alternate PDS) environment variables to be logged in when the app is initialized and skip the login screen.
- Check your default settings by opening the command palette and going to settings: `ctrl+p` -> `Settings`, or configure the `settings.json` file manually. The file will be created automatically at `data/settings.json` in the installed location the first time the app is opened. See [https://skyter.readthedocs.io/en/latest/settings.html](https://skyter.readthedocs.io/en/latest/settings.html) for more details.
