1
0
mirror of https://github.com/ihabunek/toot.git synced 2024-12-04 14:46:33 -05:00
Go to file
2024-11-27 19:59:29 +01:00
.github/workflows Drop support for python 3.7 2024-04-13 09:21:41 +02:00
docs Update changelog 2024-11-27 19:59:29 +01:00
scripts Remove version checks from tag script 2024-04-13 09:06:00 +02:00
tests Fix deprecation warning 2024-11-27 19:45:48 +01:00
toot Don't set default visibility to public 2024-11-27 19:55:48 +01:00
.coveragerc Set up code coverage 2022-11-29 11:54:45 +01:00
.flake8 Added 'toot diag' command that outputs useful diagnostic info 2024-06-13 20:35:45 -04:00
.gitignore Add make bundle for creating a pyz bundle 2023-12-05 08:52:07 +01:00
.vermin Bump python version for vermin 2024-04-13 09:24:58 +02:00
book.css Add new mdbook docs 2023-03-03 13:55:20 +01:00
book.toml Add new mdbook docs 2023-03-03 13:55:20 +01:00
CHANGELOG.md Update changelog 2024-11-27 19:59:29 +01:00
changelog.yaml Update changelog 2024-11-27 19:59:29 +01:00
CONTRIBUTING.md Update Setting up dev environnement (#496) 2024-09-29 09:35:19 +02:00
LICENSE Change license to GPLv3 2017-05-08 09:17:32 +02:00
Makefile Use build for packaging 2024-04-13 09:09:17 +02:00
MANIFEST.in Include tests in sdist 2019-09-18 08:05:07 +02:00
pyproject.toml Make type checking not strict until we add types 2024-08-12 10:38:30 +02:00
pytest.ini Limit test files 2023-12-05 08:58:31 +01:00
README.rst Updated images and readme 2024-08-12 09:52:36 +02:00
trumpet.png Resize image 2018-06-25 14:30:18 +02:00

============================
Toot - a Mastodon CLI client
============================

.. image:: https://raw.githubusercontent.com/ihabunek/toot/master/trumpet.png

Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.

.. image:: https://img.shields.io/badge/author-%40ihabunek-blue.svg?maxAge=3600&style=flat-square
   :target: https://mastodon.social/@ihabunek
.. image:: https://img.shields.io/github/license/ihabunek/toot.svg?maxAge=3600&style=flat-square
   :target: https://opensource.org/licenses/GPL-3.0
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
   :target: https://pypi.python.org/pypi/toot

Resources
---------

* Homepage: https://github.com/ihabunek/toot
* Issues: https://github.com/ihabunek/toot/issues
* Documentation: https://toot.bezdomni.net/
* Mailing list for discussion, support and patches:
  https://lists.sr.ht/~ihabunek/toot-discuss
* Informal discussion: #toot IRC channel on `libera.chat <https://libera.chat/>`_

Features
--------

* Posting, replying, deleting statuses
* Support for media uploads, spoiler text, sensitive content
* Search by account or hash tag
* Following, muting and blocking accounts
* Simple switching between authenticated in Mastodon accounts

Terminal User Interface
-----------------------

toot includes a terminal user interface (TUI). Run it with ``toot tui``.

TUI Features:
-------------

* Block graphic image display (requires optional libraries `pillow <https://pypi.org/project/pillow/>`, `term-image <https://pypi.org/project/term-image/>`, and `urwidgets <https://pypi.org/project/urwidgets/>`)
* Bitmapped image display in `kitty <https://sw.kovidgoyal.net/kitty/>` terminal ``toot tui -f kitty``
* Bitmapped image display in `iTerm2 <https://iterm2.com/>`, or `WezTerm <https://wezfurlong.org/wezterm/index.html>` terminal ``toot tui -f iterm``


.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_list.png

.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_compose.png

License
-------

Copyright Ivan Habunek <ivan@habunek.com> and contributors.

Licensed under `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.html>`_, see `LICENSE <LICENSE>`_.