1
0
mirror of https://github.com/ihabunek/toot.git synced 2024-09-29 04:35:54 -04:00
Go to file
Ivan Habunek d5b5c89996
Add support for custom instance domains
The instance domain can be different from their base url, for example
the instance at https://social.vivaldi.net uses the vivaldi.net domain,
sans 'social'.

This commit requires the user to provide the base url of the instance,
instead of domain name. The domain is then fetched from the server.

fixes #217
2023-03-09 11:00:45 +01:00
.github/workflows Run tests on pull requests 2023-01-01 11:11:10 +01:00
docs Document how to generate docs 2023-03-03 17:12:59 +01:00
scripts Add checks to tag script 2019-09-03 16:45:31 +02:00
tests Test media thumbnails 2023-03-03 11:44:40 +01:00
toot Add support for custom instance domains 2023-03-09 11:00:45 +01:00
.coveragerc Set up code coverage 2022-11-29 11:54:45 +01:00
.flake8 Ignore venv folder for flake8 and vermin tests 2023-01-19 09:17:52 +01:00
.gitignore Add new mdbook docs 2023-03-03 13:55:20 +01:00
.travis.yml Use make command to run tests (for real now) 2019-09-18 21:55:35 +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 references to new documentation 2023-03-03 16:54:40 +01:00
changelog.yaml Update references to new documentation 2023-03-03 16:54:40 +01:00
CONTRIBUTING.md Update references to new documentation 2023-03-03 16:54:40 +01:00
LICENSE Change license to GPLv3 2017-05-08 09:17:32 +02:00
Makefile Add new mdbook docs 2023-03-03 13:55:20 +01:00
MANIFEST.in Include tests in sdist 2019-09-18 08:05:07 +02:00
README.rst Update references to new documentation 2023-03-03 16:54:40 +01:00
requirements-dev.txt Add github actions workflow 2022-12-02 09:27:14 +01:00
requirements-test.txt Add flake8 to test dependencies 2022-12-27 12:17:31 +01:00
requirements.txt Don't limit upper version on wcwidth 2022-11-12 09:26:31 +01:00
setup.py Update references to new documentation 2023-03-03 16:54:40 +01: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/travis/ihabunek/toot.svg?maxAge=3600&style=flat-square
   :target: https://travis-ci.org/ihabunek/toot
.. 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``.

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

.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/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>`_.