A Mastodon TUI client.
Project description
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
- "Infinite" scrolling of timelines
- Like posts
- View user profiles
- Follow/Unfollow users
- View post threads
- Support for local Mastodon servers
- Light/Dark mode theming
- Content warning support
TODO
- database backend
- Bookmarking
- Hashtag Searching
- Unliking posts
- Direct Messaging
Installation
The recommended way to install Mastui is with pipx.
-
Install pipx (if you don't have it already):
python3 -m pip install --user pipx python3 -m pipx ensurepath
-
Install mastui using pipx:
pipx install mastui
After this, you can run the application from anywhere by simply typing mastui.
Technology Stack
- Python
- Poetry for dependency management
- Textual for the TUI framework
- Mastodon.py for interacting with the Mastodon API
- html2text for converting HTML to Markdown
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mastui-0.3.1.tar.gz.
File metadata
- Download URL: mastui-0.3.1.tar.gz
- Upload date:
- Size: 16.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/5.15.167.4-microsoft-standard-WSL2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
92d7e3eac2bad076d9e253221daa01de40ffb5ad643bd54fe0c6022762997fe9
|
|
| MD5 |
849763a4b73eb7a1b294ed7b8815fbdc
|
|
| BLAKE2b-256 |
82aae8c3f069e9291d2af87bf627967c2b63caaec8fe5e0e39420c43ad8eb316
|
File details
Details for the file mastui-0.3.1-py3-none-any.whl.
File metadata
- Download URL: mastui-0.3.1-py3-none-any.whl
- Upload date:
- Size: 21.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/5.15.167.4-microsoft-standard-WSL2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
296f06d4aa2e32db36ad99f27c6e64baa816728f59e99db08c0b2cd80228be39
|
|
| MD5 |
412a4163bedfba718fe9b30141ea7672
|
|
| BLAKE2b-256 |
b7d0b3a685a786234cc420a78dcdcf418965cc6ccc2827e5263e9e62ef8a761b
|
