mastui 0.5.3

A Mastodon TUI client.

Mastui - A Mastodon TUI Client Built with Python

Mastui is a Mastodon TUI client built with Python and Textual. It allows users to interact with their Mastodon instance in a terminal environment, providing a more efficient and intuitive way of managing their Mastodon experience. The UI is multi-column to get an easy overview of activities.

Features

• Timeline Viewing in a multi-column layout
• Post and Reply creation with character counter
• "Infinite" scrolling of timelines
• Like/Unlike posts
• View user profiles
• Follow/Unfollow users
• View post threads
• Support for local Mastodon servers
• Configurable light/dark mode theming
• Content warning support
• Auto-refreshing timelines (configurable)
• Image viewing with multiple renderers (Auto, ANSI, Sixel, TGP), lazy-loaded

TODO

• database backend
• Bookmarking
• Hashtag Searching
• Unliking posts
• Direct Messaging

Installation

The recommended way to install Mastui is with pipx.

1. Install pipx (if you don't have it already):

   python3 -m pip install --user pipx
   python3 -m pipx ensurepath
   

2. Install mastui using pipx:

   pipx install mastui
   

After this, you can run the application from anywhere by simply typing mastui.

Upgrading

To upgrade to the latest version of Mastui, run the following command:

pipx upgrade mastui

Technology Stack

• Python
• Poetry for dependency management
• Textual for the TUI framework
• textual-image for image rendering
• Mastodon.py for interacting with the Mastodon API
• httpx for HTTP requests
• html2text for converting HTML to Markdown
• python-dateutil for parsing datetimes

License

Mastui is licensed under the MIT license. See LICENSE for more information.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Kim Schulz - Initial work - kimusan

See also the list of contributors who participated in this project.

Acknowledgments

• Inspiration and guidance from the Textual community and the Poetry team
• The Mastodon community for their contributions to the development of the application and its features
• Other projects that have inspired or influenced the design of Mastui

Please feel free to reach out to me if you have any questions, comments, or concerns.