Add new mdbook docs
This commit is contained in:
parent
33fb3c790d
commit
32d65a1615
20 changed files with 1591 additions and 1 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -8,9 +8,9 @@
|
||||||
/.pytest_cache/
|
/.pytest_cache/
|
||||||
/build/
|
/build/
|
||||||
/dist/
|
/dist/
|
||||||
/docs/_build/
|
|
||||||
/htmlcov/
|
/htmlcov/
|
||||||
/tmp/
|
/tmp/
|
||||||
/toot-*.tar.gz
|
/toot-*.tar.gz
|
||||||
debug.log
|
debug.log
|
||||||
/pyrightconfig.json
|
/pyrightconfig.json
|
||||||
|
/book
|
||||||
|
|
|
||||||
10
Makefile
10
Makefile
|
|
@ -24,3 +24,13 @@ clean :
|
||||||
|
|
||||||
changelog:
|
changelog:
|
||||||
./scripts/generate_changelog > CHANGELOG.md
|
./scripts/generate_changelog > CHANGELOG.md
|
||||||
|
cp CHANGELOG.md docs/changelog.md
|
||||||
|
|
||||||
|
docs: changelog
|
||||||
|
mdbook build
|
||||||
|
|
||||||
|
docs-serve:
|
||||||
|
mdbook serve
|
||||||
|
|
||||||
|
docs-deploy: docs
|
||||||
|
rsync --archive --compress --delete --stats book/ bezdomni:web/toot
|
||||||
|
|
|
||||||
13
book.css
Normal file
13
book.css
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
/* Overrides for the docs theme */
|
||||||
|
table { width: 100% }
|
||||||
|
table th { text-align: left }
|
||||||
|
code { white-space: pre }
|
||||||
|
h2, h3 { margin-top: 2.5rem; }
|
||||||
|
h4, h5 { margin-top: 2rem; }
|
||||||
|
|
||||||
|
td.code {
|
||||||
|
font-family: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace !important;
|
||||||
|
font-size: 0.875em;
|
||||||
|
width: 20%;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
13
book.toml
Normal file
13
book.toml
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
[book]
|
||||||
|
authors = ["Ivan Habunek"]
|
||||||
|
language = "en"
|
||||||
|
multilingual = false
|
||||||
|
src = "docs"
|
||||||
|
title = "toot"
|
||||||
|
|
||||||
|
[output.html]
|
||||||
|
additional-css = ["book.css"]
|
||||||
|
|
||||||
|
[preprocessor.toc]
|
||||||
|
command = "mdbook-toc"
|
||||||
|
renderer = ["html"]
|
||||||
13
docs/SUMMARY.md
Normal file
13
docs/SUMMARY.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# Summary
|
||||||
|
|
||||||
|
[Introduction](introduction.md)
|
||||||
|
|
||||||
|
- [Installation](installation.md)
|
||||||
|
- [Usage](usage.md)
|
||||||
|
- [Advanced](advanced.md)
|
||||||
|
- [TUI](tui.md)
|
||||||
|
- [Contributing](contributing.md)
|
||||||
|
- [Changelog](changelog.md)
|
||||||
|
- [Release procedure](release.md)
|
||||||
|
|
||||||
|
[License](license.md)
|
||||||
39
docs/advanced.md
Normal file
39
docs/advanced.md
Normal file
|
|
@ -0,0 +1,39 @@
|
||||||
|
Advanced usage
|
||||||
|
==============
|
||||||
|
|
||||||
|
Disabling HTTPS
|
||||||
|
---------------
|
||||||
|
|
||||||
|
You may pass the `--disable-https` flag to use unencrypted HTTP instead of
|
||||||
|
HTTPS for a given instance. This is inherently insecure and should be used only
|
||||||
|
when connecting to local development instances.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot login --disable-https --instance localhost:8080
|
||||||
|
```
|
||||||
|
|
||||||
|
Using proxies
|
||||||
|
-------------
|
||||||
|
|
||||||
|
You can configure proxies by setting the `HTTPS_PROXY` or `HTTP_PROXY`
|
||||||
|
environment variables. This will cause all http(s) requests to be proxied
|
||||||
|
through the specified server.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
export HTTPS_PROXY="http://1.2.3.4:5678"
|
||||||
|
toot login --instance mastodon.social
|
||||||
|
|
||||||
|
**NB:** This feature is provided by
|
||||||
|
[requests](http://docs.python-requests.org/en/master/user/advanced/#proxies>)
|
||||||
|
and setting the environment variable will affect other programs using this
|
||||||
|
library.
|
||||||
|
|
||||||
|
This environment can be set for a single call to toot by prefixing the command
|
||||||
|
with the environment variable:
|
||||||
|
|
||||||
|
```
|
||||||
|
HTTPS_PROXY="http://1.2.3.4:5678" toot login --instance mastodon.social
|
||||||
|
```
|
||||||
351
docs/changelog.md
Normal file
351
docs/changelog.md
Normal file
|
|
@ -0,0 +1,351 @@
|
||||||
|
Changelog
|
||||||
|
---------
|
||||||
|
|
||||||
|
<!-- Do not edit. This file is automatically generated from changelog.yaml.-->
|
||||||
|
|
||||||
|
**0.35.0 (2023-03-01)**
|
||||||
|
|
||||||
|
* Save toot contents when using --editor so it's recoverable if posting fails
|
||||||
|
(#311)
|
||||||
|
* TUI: Add voting on polls (thanks Dan Schwarz)
|
||||||
|
* TUI: Add following/blocking/muting accounts (thanks Dan Schwarz)
|
||||||
|
* TUI: Add notifications timeline (thanks Dan Schwarz)
|
||||||
|
|
||||||
|
**0.34.1 (2023-02-20)**
|
||||||
|
|
||||||
|
* TUI: Fix bug where TUI would break on older Mastodon instances (#309)
|
||||||
|
|
||||||
|
**0.34.0 (2023-02-03)**
|
||||||
|
|
||||||
|
* Fix Python version detection which would fail in some cases (thanks K)
|
||||||
|
* Fix toot --help not working (thanks Norman Walsh)
|
||||||
|
* TUI: Add option to save status JSON data from source window (thanks Dan
|
||||||
|
Schwarz)
|
||||||
|
* TUI: Add `--relative-datetimes` option to show relative datetimes (thanks Dan
|
||||||
|
Schwarz)
|
||||||
|
* TUI: Don't focus newly created post (#188, thanks Dan Schwarz)
|
||||||
|
* TUI: Add ability to scroll long status messages (#166, thanks Dan Schwarz)
|
||||||
|
* TUI: Add action to view account details (thanks Dan Schwarz)
|
||||||
|
|
||||||
|
**0.33.1 (2023-01-03)**
|
||||||
|
|
||||||
|
* TUI: Fix crash when viewing toot in browser
|
||||||
|
|
||||||
|
**0.33.0 (2023-01-02)**
|
||||||
|
|
||||||
|
* Add CONTRIBUTING.md containing a contribution guide
|
||||||
|
* Add `env` command which prints local env to include in issues
|
||||||
|
* Add TOOT_POST_VISIBILITY environment to control default post visibility
|
||||||
|
(thanks Lim Ding Wen)
|
||||||
|
* Add `tags_followed`, `tags_follow`, and `tags_unfollow` commands (thanks
|
||||||
|
Daniel Schwarz)
|
||||||
|
* Add `tags_bookmarks` command (thanks Giuseppe Bilotta)
|
||||||
|
* TUI: Show an error if attemptint to boost a private status (thanks Lim Ding
|
||||||
|
Wen)
|
||||||
|
* TUI: Hide polls, cards and media attachments for sensitive posts (thanks
|
||||||
|
Daniel Schwarz)
|
||||||
|
* TUI: Add bookmarking and bookmark timeline (thanks Daniel Schwarz)
|
||||||
|
* TUI: Show status visiblity (thanks Lim Ding Wen)
|
||||||
|
* TUI: Reply to original account instead of boosting account (thanks Lim Ding
|
||||||
|
Wen)
|
||||||
|
* TUI: Refresh screen after exiting browser, required for text browsers (thanks
|
||||||
|
Daniel Schwarz)
|
||||||
|
* TUI: Highlight followed tags (thanks Daniel Schwarz)
|
||||||
|
|
||||||
|
**0.32.1 (2022-12-12)**
|
||||||
|
|
||||||
|
* Fix packaging issue, missing toot.utils module
|
||||||
|
|
||||||
|
**0.32.0 (2022-12-12)**
|
||||||
|
|
||||||
|
* TUI: Press N to translate status, if available on your instance (thanks Daniel
|
||||||
|
Schwarz)
|
||||||
|
* Fix: `post --language` option now accepts two-letter country code instead of
|
||||||
|
3-letter. This was changed by mastodon at some point.
|
||||||
|
* Fix: Failing to find accounts using qualified usernames (#254)
|
||||||
|
|
||||||
|
**0.31.0 (2022-12-07)**
|
||||||
|
|
||||||
|
* **BREAKING:** Require Python 3.6+
|
||||||
|
* Add `post --scheduled-in` option for easier scheduling
|
||||||
|
* Fix posting toots to Pleroma
|
||||||
|
* Improved testing
|
||||||
|
|
||||||
|
**0.30.1 (2022-11-30)**
|
||||||
|
|
||||||
|
* Remove usage of depreacted `text_url` status field. Fixes posting media
|
||||||
|
without text.
|
||||||
|
|
||||||
|
**0.30.0 (2022-11-29)**
|
||||||
|
|
||||||
|
* Display polls in `timeline` (thanks Daniel Schwarz)
|
||||||
|
* TUI: Add [,] shortcut to reload timeline (thanks Daniel Schwarz)
|
||||||
|
* TUI: Add [Z] shortcut to zoom status - allows scrolling (thanks
|
||||||
|
@PeterFidelman)
|
||||||
|
* Internals: add integration tests against a local mastodon instance
|
||||||
|
|
||||||
|
**0.29.0 (2022-11-21)**
|
||||||
|
|
||||||
|
* Add `bookmark` and `unbookmark` commands
|
||||||
|
* Add `following` and `followers` commands (thanks @Oblomov)
|
||||||
|
* TUI: Show media attachments in links list (thanks @PeterFidelman)
|
||||||
|
* Fix tests so that they don't depend on the local timezone
|
||||||
|
|
||||||
|
**0.28.1 (2022-11-12)**
|
||||||
|
|
||||||
|
* Fix account search to be case insensitive (thanks @TheJokersThief)
|
||||||
|
* Fix account search to use v2 endpoint, since v1 endpoint was removed on some
|
||||||
|
instances (thanks @kaja47)
|
||||||
|
* Add '.toot' extension to temporary files when composing toot in an editor
|
||||||
|
(thanks @larsks)
|
||||||
|
* Display localized datetimes in timeline (thanks @mmmmmmbeer)
|
||||||
|
* Don't use # for comments when composing toot in an editor, since that made it
|
||||||
|
impossible to post lines starting with #.
|
||||||
|
* TUI: Fix crash when poll does not have an expiry date
|
||||||
|
|
||||||
|
**0.28.0 (2021-08-28)**
|
||||||
|
|
||||||
|
* **BREAKING**: Removed `toot curses`, deprecated since 2019-09-03
|
||||||
|
* Add `--scheduled-at` option to `toot post`, allows scheduling toots
|
||||||
|
* Add `--description` option to `toot post`, for adding descriptions to media
|
||||||
|
attachments (thanks @ansuz)
|
||||||
|
* Add `--mentions` option to `toot notifications` to show only mentions (thanks
|
||||||
|
@alexwennerberg)
|
||||||
|
* Add `--content-type` option to `toot post` to allow specifying mime type, used
|
||||||
|
on Pleroma (thanks Sandra Snan)
|
||||||
|
* Allow post IDs to be strings as used on Pleroma (thanks Sandra Snan)
|
||||||
|
* TUI: Allow posts longer than 500 characters if so configured on the server
|
||||||
|
(thanks Sandra Snan)
|
||||||
|
* Allow piping the password to login_cli for testing purposes (thanks
|
||||||
|
@NinjaTrappeur)
|
||||||
|
* Disable paging timeline when output is piped (thanks @stacyharper)
|
||||||
|
|
||||||
|
**0.27.0 (2020-06-15)**
|
||||||
|
|
||||||
|
* TUI: Fix access to public and tag timelines when on private mastodon instances
|
||||||
|
(#168)
|
||||||
|
* Add `--reverse` option to `toot notifications` (#151)
|
||||||
|
* Fix `toot timeline` to respect `--instance` option
|
||||||
|
* TUI: Add opton to pin/save tag timelines (#163, thanks @dlax)
|
||||||
|
* TUI: Fixed crash on empty timeline (#138, thanks ecs)
|
||||||
|
|
||||||
|
**0.26.0 (2020-04-15)**
|
||||||
|
|
||||||
|
* Fix datetime parsing on Python 3.5 (#162)
|
||||||
|
* TUI: Display status links and open them (#154, thanks @dlax)
|
||||||
|
* TUI: Fix visibility descriptions (#153, thanks @finnoleary)
|
||||||
|
* **IMPORTANT:** Starting from this release, new releases will not be uploaded
|
||||||
|
to the APT package repository at `bezdomni.net`. Please use the official
|
||||||
|
Debian or Ubuntu repos or choose another [installation
|
||||||
|
option](https://toot.readthedocs.io/en/latest/install.html).
|
||||||
|
|
||||||
|
**0.25.2 (2020-01-23)**
|
||||||
|
|
||||||
|
* Revert adding changelog and readme to sourceballs (#149)
|
||||||
|
* TUI: Fall back to username when display_name is unset (thanks @dlax)
|
||||||
|
* Note: 0.25.1 was skipped due to error when releasing
|
||||||
|
|
||||||
|
**0.25.0 (2020-01-21)**
|
||||||
|
|
||||||
|
* TUI: Show character count when composing (#121)
|
||||||
|
* Include changelog and license in sourceballs (#133)
|
||||||
|
* Fix searching by hashtag which include the '#' (#134)
|
||||||
|
* Upgrade search to v2 (#135)
|
||||||
|
* Fix compatibility with Python < 3.6 (don't use fstrings)
|
||||||
|
|
||||||
|
**0.24.0 (2019-09-18)**
|
||||||
|
|
||||||
|
* On Windows store config files under %APPDATA%
|
||||||
|
* CLI: Don't use ANSI colors if not supported by terminal or when not in a tty
|
||||||
|
* TUI: Implement deleting own status messages
|
||||||
|
* TUI: Improve rendering of reblogged statuses (thanks @dlax)
|
||||||
|
* TUI: Set urwid encoding to UTF-8 (thanks @bearzk)
|
||||||
|
|
||||||
|
**0.23.1 (2019-09-04)**
|
||||||
|
|
||||||
|
* Fix a date parsing bug in Python versions <3.7 (#114)
|
||||||
|
|
||||||
|
**0.23.0 (2019-09-03)**
|
||||||
|
|
||||||
|
* Add `toot tui`, new and improved TUI implemented written with the help of the
|
||||||
|
[urwid](http://urwid.org/) library
|
||||||
|
* Deprecate `toot curses`. It will show a deprecation notice when started. To be
|
||||||
|
removed in a future release
|
||||||
|
* Add `--editor` option to `toot post` to allow composing toots in an editor
|
||||||
|
(#90)
|
||||||
|
* Fix config file permissions, set them to 0600 when creating the initial config
|
||||||
|
file (#109)
|
||||||
|
* Add user agent string to all requests, fixes interaction with instances
|
||||||
|
protected by Cloudflare (#106)
|
||||||
|
|
||||||
|
**0.22.0 (2019-08-01)**
|
||||||
|
|
||||||
|
* **BREAKING:** Dropped support for Python 3.3
|
||||||
|
* Add `toot notifications` to show notifications (thanks @dlax)
|
||||||
|
* Add posting and replying to curses interface (thanks @Skehmatics)
|
||||||
|
* Add `--language` option to `toot post`
|
||||||
|
* Enable attaching upto 4 files via `--media` option on `toot post`
|
||||||
|
|
||||||
|
**0.21.0 (2019-02-15)**
|
||||||
|
|
||||||
|
* **BREAKING:** in `toot timeline` short argument for selecting a list is no
|
||||||
|
longer `-i`, this has been changed to select the instance, so that it is the
|
||||||
|
same as on other commands, please use the long form `--list` instead
|
||||||
|
* Add `toot reblogged_by` to show who reblogged a status (#88)
|
||||||
|
* Add `toot thread` to show a status with its replies (#87)
|
||||||
|
* Better handling of wide characters (eastern scripts, emojis) (#84)
|
||||||
|
* Improved `timeline`, nicer visuals, and it will now ask to show next batch of
|
||||||
|
toots, unless given the `--once` option
|
||||||
|
* Add public/local/tag timelines to `timeline` and `curses`
|
||||||
|
* Support for boosting and favouriting in `toot curses`, press `f`/`b` (#88,
|
||||||
|
#93)
|
||||||
|
|
||||||
|
**0.20.0 (2019-02-01)**
|
||||||
|
|
||||||
|
* Enable interaction with instances using http instead of https (#56)
|
||||||
|
* Enable proxy usage via environment variables (#47)
|
||||||
|
* Make `toot post` prompt for input if no text is given (#82)
|
||||||
|
* Add post-related commands: `favourite`, `unfavourite`, `reblog`, `unreblog`,
|
||||||
|
`pin` & `unpin` (#75)
|
||||||
|
|
||||||
|
**0.19.0 (2018-06-27)**
|
||||||
|
|
||||||
|
* Add support for replying to a toot (#6)
|
||||||
|
* Add `toot delete` command for deleting a toot (#54)
|
||||||
|
* Add global `--quiet` flag to silence output (#46)
|
||||||
|
* Make `toot login` provide browser login, and `toot login_cli` log in via
|
||||||
|
console. This makes it clear what's the preferred option.
|
||||||
|
* Use Idempotency-Key header to prevent multiple toots being posted if request
|
||||||
|
is retried
|
||||||
|
* Fix a bug where all media would be marked as sensitive
|
||||||
|
|
||||||
|
**0.18.0 (2018-06-12)**
|
||||||
|
|
||||||
|
* Add support for public, tag and list timelines in `toot timeline` (#52)
|
||||||
|
* Add `--sensitive` and `--spoiler-text` options to `toot post` (#63)
|
||||||
|
* Curses app improvements (respect sensitive content, require keypress to show,
|
||||||
|
add help modal, misc improvements)
|
||||||
|
|
||||||
|
**0.17.1 (2018-01-15)**
|
||||||
|
|
||||||
|
* Create config folder if it does not exist (#40)
|
||||||
|
* Fix packaging to include `toot.ui` package (#41)
|
||||||
|
|
||||||
|
**0.17.0 (2018-01-15)**
|
||||||
|
|
||||||
|
* Changed configuration file format to allow switching between multiple logged
|
||||||
|
in accounts (#32)
|
||||||
|
* Respect XDG_CONFIG_HOME environment variable to locate config home (#12)
|
||||||
|
* Dynamically calculate left window width, supports narrower windows (#27)
|
||||||
|
* Redraw windows when terminal size changes (#25)
|
||||||
|
* Support scrolling the status list
|
||||||
|
* Fetch next batch of statuses when bottom is reached
|
||||||
|
* Support up/down arrows (#30)
|
||||||
|
* Misc visual improvements
|
||||||
|
|
||||||
|
**0.16.2 (2018-01-02)**
|
||||||
|
|
||||||
|
* No changes, pushed to fix a packaging issue
|
||||||
|
|
||||||
|
**0.16.1 (2017-12-30)**
|
||||||
|
|
||||||
|
* Fix bug with app registration
|
||||||
|
|
||||||
|
**0.16.0 (2017-12-30)**
|
||||||
|
|
||||||
|
* **BREAKING:** Dropped support for Python 2, because it's a pain to support and
|
||||||
|
caused bugs with handling unicode.
|
||||||
|
* Remove hacky `login_2fa` command, use `login_browser` instead
|
||||||
|
* Add `instance` command
|
||||||
|
* Allow `post`ing media without text (#24)
|
||||||
|
|
||||||
|
**0.15.1 (2017-12-12)**
|
||||||
|
|
||||||
|
* Fix crash when toot's URL is None (#33), thanks @veer66
|
||||||
|
|
||||||
|
**0.15.0 (2017-09-09)**
|
||||||
|
|
||||||
|
* Fix Windows compatibility (#18)
|
||||||
|
|
||||||
|
**0.14.0 (2017-09-07)**
|
||||||
|
|
||||||
|
* Add `--debug` option to enable debug logging instead of using the `TOOT_DEBUG`
|
||||||
|
environment variable.
|
||||||
|
* Fix: don't read requirements.txt from setup.py, this fails when packaging deb
|
||||||
|
and potentially in some other cases (see #18)
|
||||||
|
|
||||||
|
**0.13.0 (2017-08-26)**
|
||||||
|
|
||||||
|
* Allow passing `--instance` and `--email` to login command
|
||||||
|
* Add `login_browser` command for proper two factor authentication through the
|
||||||
|
browser (#19, #23)
|
||||||
|
|
||||||
|
**0.12.0 (2017-05-08)**
|
||||||
|
|
||||||
|
* Add option to disable ANSI color in output (#15)
|
||||||
|
* Return nonzero error code on error (#14)
|
||||||
|
* Change license to GPLv3
|
||||||
|
|
||||||
|
**0.11.0 (2017-05-07)**
|
||||||
|
|
||||||
|
* Fix error when running toot from crontab (#11)
|
||||||
|
* Minor tweaks
|
||||||
|
|
||||||
|
**0.10.0 (2017-04-26)**
|
||||||
|
|
||||||
|
* Add commands: `block`, `unblock`, `mute`, `unmute`
|
||||||
|
* Internal improvements
|
||||||
|
|
||||||
|
**0.9.1 (2017-04-24)**
|
||||||
|
|
||||||
|
* Fix conflict with curses package name
|
||||||
|
|
||||||
|
**0.9.0 (2017-04-21)**
|
||||||
|
|
||||||
|
* Add `whois` command
|
||||||
|
* Add experimental `curses` app for viewing the timeline
|
||||||
|
|
||||||
|
**0.8.0 (2017-04-19)**
|
||||||
|
|
||||||
|
* **BREAKING:** Renamed command `2fa` to `login_2fa`
|
||||||
|
* It is now possible to pipe text into `toot post`
|
||||||
|
|
||||||
|
**0.7.0 (2017-04-18)**
|
||||||
|
|
||||||
|
* **WARNING:** Due to changes in configuration format, after upgrading to this
|
||||||
|
version, you will be required to log in to your Mastodon instance again.
|
||||||
|
* Experimental 2FA support (#3)
|
||||||
|
* Do not create a new application for each login
|
||||||
|
|
||||||
|
**0.6.0 (2017-04-17)**
|
||||||
|
|
||||||
|
* Add `whoami` command
|
||||||
|
* Migrate from `optparse` to `argparse`
|
||||||
|
|
||||||
|
**0.5.0 (2017-04-16)**
|
||||||
|
|
||||||
|
* Add `search`, `follow` and `unfollow` commands
|
||||||
|
* Migrate from `optparse` to `argparse`
|
||||||
|
|
||||||
|
**0.4.0 (2017-04-15)**
|
||||||
|
|
||||||
|
* Add `upload` command to post media
|
||||||
|
* Add `--visibility` and `--media` options to `post` command
|
||||||
|
|
||||||
|
**0.3.0 (2017-04-13)**
|
||||||
|
|
||||||
|
* Add: view timeline
|
||||||
|
* Require an explicit login
|
||||||
|
|
||||||
|
**0.2.1 (2017-04-13)**
|
||||||
|
|
||||||
|
* Fix invalid requirements in setup.py
|
||||||
|
|
||||||
|
**0.2.0 (2017-04-12)**
|
||||||
|
|
||||||
|
* Bugfixes
|
||||||
|
|
||||||
|
**0.1.0 (2017-04-12)**
|
||||||
|
|
||||||
|
* Initial release
|
||||||
|
|
||||||
150
docs/contributing.md
Normal file
150
docs/contributing.md
Normal file
|
|
@ -0,0 +1,150 @@
|
||||||
|
Toot contribution guide
|
||||||
|
=======================
|
||||||
|
|
||||||
|
Firstly, thank you for contributing to toot!
|
||||||
|
|
||||||
|
Relevant links which will be referenced below:
|
||||||
|
|
||||||
|
* [toot documentation](https://toot.readthedocs.io/)
|
||||||
|
* [toot-discuss mailing list](https://lists.sr.ht/~ihabunek/toot-discuss)
|
||||||
|
used for discussion as well as accepting patches
|
||||||
|
* [toot project on github](https://github.com/ihabunek/toot)
|
||||||
|
here you can report issues and submit pull requests
|
||||||
|
* #toot IRC channel on [libera.chat](https://libera.chat)
|
||||||
|
|
||||||
|
## Code of conduct
|
||||||
|
|
||||||
|
Please be kind and patient. Toot is maintained by one human with a full time
|
||||||
|
job.
|
||||||
|
|
||||||
|
## I have a question
|
||||||
|
|
||||||
|
First, check if your question is addressed in the documentation or the mailing
|
||||||
|
list. If not, feel free to send an email to the mailing list. You may want to
|
||||||
|
subscribe to the mailing list to receive replies.
|
||||||
|
|
||||||
|
Alternatively, you can ask your question on the IRC channel and ping me
|
||||||
|
(ihabunek). You may have to wait for a response, please be patient.
|
||||||
|
|
||||||
|
Please don't open Github issues for questions.
|
||||||
|
|
||||||
|
## I want to contribute
|
||||||
|
|
||||||
|
### Reporting a bug
|
||||||
|
|
||||||
|
First check you're using the
|
||||||
|
[latest version](https://github.com/ihabunek/toot/releases/) of toot and verify
|
||||||
|
the bug is present in this version.
|
||||||
|
|
||||||
|
Search [Github issues](https://github.com/ihabunek/toot/issues) to check the bug
|
||||||
|
hasn't already been reported.
|
||||||
|
|
||||||
|
To report a bug open an
|
||||||
|
[issue on Github](https://github.com/ihabunek/toot/issues) or send an
|
||||||
|
email to the [mailing list](https://lists.sr.ht/~ihabunek/toot-discuss).
|
||||||
|
|
||||||
|
* Run `toot env` and include its contents in the bug report.
|
||||||
|
* Explain the behavior you would expect and the actual behavior.
|
||||||
|
* Please provide as much context as possible and describe the reproduction steps
|
||||||
|
that someone else can follow to recreate the issue on their own.
|
||||||
|
|
||||||
|
### Suggesting enhancements
|
||||||
|
|
||||||
|
This includes suggesting new features or changes to existing ones.
|
||||||
|
|
||||||
|
Search Github issues to check the enhancement has not already been requested. If
|
||||||
|
it hasn't, [open a new issue](https://github.com/ihabunek/toot/issues).
|
||||||
|
|
||||||
|
Your request will be reviewed to see if it's a good fit for toot. Implementing
|
||||||
|
requested features depends on the available time and energy of the maintainer
|
||||||
|
and other contributors.
|
||||||
|
|
||||||
|
### Contributing code
|
||||||
|
|
||||||
|
When contributing to toot, please only submit code that you have authored or
|
||||||
|
code whose license allows it to be included in toot. You agree that the code
|
||||||
|
you submit will be published under the [toot license](LICENSE).
|
||||||
|
|
||||||
|
#### Setting up a dev environment
|
||||||
|
|
||||||
|
Check out toot (or a fork) and install it into a virtual environment.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone git@github.com:ihabunek/toot.git
|
||||||
|
cd toot
|
||||||
|
python3 -m venv _env
|
||||||
|
|
||||||
|
# On Linux/Mac
|
||||||
|
source _env/bin/activate
|
||||||
|
|
||||||
|
# On Windows
|
||||||
|
_env\bin\activate.bat
|
||||||
|
|
||||||
|
pip install --editable .
|
||||||
|
pip install -r requirements-dev.txt
|
||||||
|
pip install -r requirements-test.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
While the virtual env is active, running `toot` will execute the one you checked
|
||||||
|
out. This allows you to make changes and test them.
|
||||||
|
|
||||||
|
#### Crafting good commits
|
||||||
|
|
||||||
|
Please put some effort into breaking your contribution up into a series of well
|
||||||
|
formed commits. If you're unsure what this means, there is a good guide
|
||||||
|
available at [https://cbea.ms/git-commit/](https://cbea.ms/git-commit/).
|
||||||
|
|
||||||
|
Rules for commits:
|
||||||
|
|
||||||
|
* each commit should ideally contain only one change
|
||||||
|
* don't bundle multiple unrelated changes into a single commit
|
||||||
|
* write descriptive and well formatted commit messages
|
||||||
|
|
||||||
|
Rules for commit messages:
|
||||||
|
|
||||||
|
* separate subject from body with a blank line
|
||||||
|
* limit the subject line to 50 characters
|
||||||
|
* capitalize the subject line
|
||||||
|
* do not end the subject line with a period
|
||||||
|
* use the imperative mood in the subject line
|
||||||
|
* wrap the body at 72 characters
|
||||||
|
* use the body to explain what and why vs. how
|
||||||
|
|
||||||
|
For a more detailed explanation with examples see the guide at
|
||||||
|
[https://cbea.ms/git-commit/](https://cbea.ms/git-commit/)
|
||||||
|
|
||||||
|
If you use vim to write your commit messages, it will already enforce some of
|
||||||
|
these rules for you.
|
||||||
|
|
||||||
|
#### Run tests before submitting
|
||||||
|
|
||||||
|
You can run code and sytle tests by running:
|
||||||
|
|
||||||
|
```
|
||||||
|
make test
|
||||||
|
```
|
||||||
|
|
||||||
|
This runs three tools:
|
||||||
|
|
||||||
|
* `pytest` runs the test suite
|
||||||
|
* `flake8` checks code formatting
|
||||||
|
* `vermin` checks that minimum python version
|
||||||
|
|
||||||
|
Please ensure all three commands succeed before submitting your patches.
|
||||||
|
|
||||||
|
#### Submitting patches
|
||||||
|
|
||||||
|
To submit your code either open
|
||||||
|
[a pull request](https://github.com/ihabunek/toot/pulls) on Github, or send
|
||||||
|
patch(es) to [the mailing list](https://lists.sr.ht/~ihabunek/toot-discuss).
|
||||||
|
|
||||||
|
If sending to the mailing list, patches should be sent using `git send-email`.
|
||||||
|
If you're unsure how to do this, there is a good guide at
|
||||||
|
[https://git-send-email.io/](https://git-send-email.io/).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Parts of this guide were taken from the following sources:
|
||||||
|
|
||||||
|
* [https://contributing.md/](https://contributing.md/)
|
||||||
|
* [https://cbea.ms/git-commit/](https://cbea.ms/git-commit/)
|
||||||
BIN
docs/images/auth.png
Normal file
BIN
docs/images/auth.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
BIN
docs/images/trumpet.png
Normal file
BIN
docs/images/trumpet.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/images/tui_compose.png
Normal file
BIN
docs/images/tui_compose.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 108 KiB |
BIN
docs/images/tui_list.png
Normal file
BIN
docs/images/tui_list.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 192 KiB |
BIN
docs/images/tui_poll.png
Normal file
BIN
docs/images/tui_poll.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 209 KiB |
22
docs/installation.md
Normal file
22
docs/installation.md
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
toot is packaged for various platforms. If possible use your OS's package manager to install toot.
|
||||||
|
|
||||||
|
[](https://repology.org/project/toot/versions)
|
||||||
|
|
||||||
|
## Python Package Index
|
||||||
|
|
||||||
|
Install from PyPI using pip, preferably into a virtual environment.
|
||||||
|
|
||||||
|
pip install toot
|
||||||
|
|
||||||
|
## Homebrew
|
||||||
|
|
||||||
|
For Mac OSX users, toot is available [in homebrew](https://formulae.brew.sh/formula/toot#default).
|
||||||
|
|
||||||
|
brew install toot
|
||||||
|
|
||||||
|
## From source
|
||||||
|
|
||||||
|
You can get the latest source distribution [from Github](https://github.com/ihabunek/toot/releases/latest/).
|
||||||
47
docs/introduction.md
Normal file
47
docs/introduction.md
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
toot - Mastodon CLI client
|
||||||
|
==========================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Toot is a CLI and TUI tool for interacting with Mastodon (and other compatible) instances from the command line.
|
||||||
|
|
||||||
|
[](https://travis-ci.org/ihabunek/toot)
|
||||||
|
[](https://mastodon.social/@ihabunek)
|
||||||
|
[](https://opensource.org/licenses/GPL-3.0)
|
||||||
|
[](https://pypi.python.org/pypi/toot)
|
||||||
|
|
||||||
|
Resources
|
||||||
|
---------
|
||||||
|
|
||||||
|
* [Documentation](https://toot.bezdomni.net/)
|
||||||
|
* [Source code on GitHub](https://github.com/ihabunek/toot)
|
||||||
|
* [Issues on GitHub](https://github.com/ihabunek/toot/issues)
|
||||||
|
* [Mailing list on Sourcehut](https://lists.sr.ht/~ihabunek/toot-discuss) for discussion, support and patches
|
||||||
|
* Informal discussion on the #toot IRC channel on [libera.chat](https://libera.chat/)
|
||||||
|
|
||||||
|
Command line client
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
* Posting, replying, deleting, favouriting, reblogging & pinning statuses
|
||||||
|
* Support for media uploads, spoiler text, sensitive content
|
||||||
|
* Search by account or hash tag
|
||||||
|
* Following, muting and blocking accounts
|
||||||
|
* Simple switching between multiple Mastodon accounts
|
||||||
|
|
||||||
|
Terminal User Interface
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
toot includes a terminal user interface. Run it with `toot tui`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
License
|
||||||
|
-------
|
||||||
|
|
||||||
|
Copyright Ivan Habunek <ivan@habunek.com> and contributors.
|
||||||
|
|
||||||
|
Licensed under the [GPLv3](http://www.gnu.org/licenses/gpl-3.0.html) license.
|
||||||
675
docs/license.md
Normal file
675
docs/license.md
Normal file
|
|
@ -0,0 +1,675 @@
|
||||||
|
### GNU GENERAL PUBLIC LICENSE
|
||||||
|
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc.
|
||||||
|
<https://fsf.org/>
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
### Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom
|
||||||
|
to share and change all versions of a program--to make sure it remains
|
||||||
|
free software for all its users. We, the Free Software Foundation, use
|
||||||
|
the GNU General Public License for most of our software; it applies
|
||||||
|
also to any other work released this way by its authors. You can apply
|
||||||
|
it to your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you
|
||||||
|
have certain responsibilities if you distribute copies of the
|
||||||
|
software, or if you modify it: responsibilities to respect the freedom
|
||||||
|
of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the
|
||||||
|
manufacturer can do so. This is fundamentally incompatible with the
|
||||||
|
aim of protecting users' freedom to change the software. The
|
||||||
|
systematic pattern of such abuse occurs in the area of products for
|
||||||
|
individuals to use, which is precisely where it is most unacceptable.
|
||||||
|
Therefore, we have designed this version of the GPL to prohibit the
|
||||||
|
practice for those products. If such problems arise substantially in
|
||||||
|
other domains, we stand ready to extend this provision to those
|
||||||
|
domains in future versions of the GPL, as needed to protect the
|
||||||
|
freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish
|
||||||
|
to avoid the special danger that patents applied to a free program
|
||||||
|
could make it effectively proprietary. To prevent this, the GPL
|
||||||
|
assures that patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
### TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
#### 0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds
|
||||||
|
of works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of
|
||||||
|
an exact copy. The resulting work is called a "modified version" of
|
||||||
|
the earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user
|
||||||
|
through a computer network, with no transfer of a copy, is not
|
||||||
|
conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices" to
|
||||||
|
the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
#### 1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work for
|
||||||
|
making modifications to it. "Object code" means any non-source form of
|
||||||
|
a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users can
|
||||||
|
regenerate automatically from other parts of the Corresponding Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that same
|
||||||
|
work.
|
||||||
|
|
||||||
|
#### 2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not convey,
|
||||||
|
without conditions so long as your license otherwise remains in force.
|
||||||
|
You may convey covered works to others for the sole purpose of having
|
||||||
|
them make modifications exclusively for you, or provide you with
|
||||||
|
facilities for running those works, provided that you comply with the
|
||||||
|
terms of this License in conveying all material for which you do not
|
||||||
|
control copyright. Those thus making or running the covered works for
|
||||||
|
you must do so exclusively on your behalf, under your direction and
|
||||||
|
control, on terms that prohibit them from making any copies of your
|
||||||
|
copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under the
|
||||||
|
conditions stated below. Sublicensing is not allowed; section 10 makes
|
||||||
|
it unnecessary.
|
||||||
|
|
||||||
|
#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such
|
||||||
|
circumvention is effected by exercising rights under this License with
|
||||||
|
respect to the covered work, and you disclaim any intention to limit
|
||||||
|
operation or modification of the work as a means of enforcing, against
|
||||||
|
the work's users, your or third parties' legal rights to forbid
|
||||||
|
circumvention of technological measures.
|
||||||
|
|
||||||
|
#### 4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
#### 5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these
|
||||||
|
conditions:
|
||||||
|
|
||||||
|
- a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
- b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under
|
||||||
|
section 7. This requirement modifies the requirement in section 4
|
||||||
|
to "keep intact all notices".
|
||||||
|
- c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
- d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
#### 6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms of
|
||||||
|
sections 4 and 5, provided that you also convey the machine-readable
|
||||||
|
Corresponding Source under the terms of this License, in one of these
|
||||||
|
ways:
|
||||||
|
|
||||||
|
- a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
- b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the Corresponding
|
||||||
|
Source from a network server at no charge.
|
||||||
|
- c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
- d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
- e) Convey the object code using peer-to-peer transmission,
|
||||||
|
provided you inform other peers where the object code and
|
||||||
|
Corresponding Source of the work are being offered to the general
|
||||||
|
public at no charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal,
|
||||||
|
family, or household purposes, or (2) anything designed or sold for
|
||||||
|
incorporation into a dwelling. In determining whether a product is a
|
||||||
|
consumer product, doubtful cases shall be resolved in favor of
|
||||||
|
coverage. For a particular product received by a particular user,
|
||||||
|
"normally used" refers to a typical or common use of that class of
|
||||||
|
product, regardless of the status of the particular user or of the way
|
||||||
|
in which the particular user actually uses, or expects or is expected
|
||||||
|
to use, the product. A product is a consumer product regardless of
|
||||||
|
whether the product has substantial commercial, industrial or
|
||||||
|
non-consumer uses, unless such uses represent the only significant
|
||||||
|
mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to
|
||||||
|
install and execute modified versions of a covered work in that User
|
||||||
|
Product from a modified version of its Corresponding Source. The
|
||||||
|
information must suffice to ensure that the continued functioning of
|
||||||
|
the modified object code is in no case prevented or interfered with
|
||||||
|
solely because modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or
|
||||||
|
updates for a work that has been modified or installed by the
|
||||||
|
recipient, or for the User Product in which it has been modified or
|
||||||
|
installed. Access to a network may be denied when the modification
|
||||||
|
itself materially and adversely affects the operation of the network
|
||||||
|
or violates the rules and protocols for communication across the
|
||||||
|
network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
#### 7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders
|
||||||
|
of that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
- a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
- b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
- c) Prohibiting misrepresentation of the origin of that material,
|
||||||
|
or requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
- d) Limiting the use for publicity purposes of names of licensors
|
||||||
|
or authors of the material; or
|
||||||
|
- e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
- f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions
|
||||||
|
of it) with contractual assumptions of liability to the recipient,
|
||||||
|
for any liability that these contractual assumptions directly
|
||||||
|
impose on those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions; the
|
||||||
|
above requirements apply either way.
|
||||||
|
|
||||||
|
#### 8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your license
|
||||||
|
from a particular copyright holder is reinstated (a) provisionally,
|
||||||
|
unless and until the copyright holder explicitly and finally
|
||||||
|
terminates your license, and (b) permanently, if the copyright holder
|
||||||
|
fails to notify you of the violation by some reasonable means prior to
|
||||||
|
60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
#### 9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or run
|
||||||
|
a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
#### 10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
#### 11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims owned
|
||||||
|
or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within the
|
||||||
|
scope of its coverage, prohibits the exercise of, or is conditioned on
|
||||||
|
the non-exercise of one or more of the rights that are specifically
|
||||||
|
granted under this License. You may not convey a covered work if you
|
||||||
|
are a party to an arrangement with a third party that is in the
|
||||||
|
business of distributing software, under which you make payment to the
|
||||||
|
third party based on the extent of your activity of conveying the
|
||||||
|
work, and under which the third party grants, to any of the parties
|
||||||
|
who would receive the covered work from you, a discriminatory patent
|
||||||
|
license (a) in connection with copies of the covered work conveyed by
|
||||||
|
you (or copies made from those copies), or (b) primarily for and in
|
||||||
|
connection with specific products or compilations that contain the
|
||||||
|
covered work, unless you entered into that arrangement, or that patent
|
||||||
|
license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
#### 12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under
|
||||||
|
this License and any other pertinent obligations, then as a
|
||||||
|
consequence you may not convey it at all. For example, if you agree to
|
||||||
|
terms that obligate you to collect a royalty for further conveying
|
||||||
|
from those to whom you convey the Program, the only way you could
|
||||||
|
satisfy both those terms and this License would be to refrain entirely
|
||||||
|
from conveying the Program.
|
||||||
|
|
||||||
|
#### 13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
#### 14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in
|
||||||
|
detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Program
|
||||||
|
specifies that a certain numbered version of the GNU General Public
|
||||||
|
License "or any later version" applies to it, you have the option of
|
||||||
|
following the terms and conditions either of that numbered version or
|
||||||
|
of any later version published by the Free Software Foundation. If the
|
||||||
|
Program does not specify a version number of the GNU General Public
|
||||||
|
License, you may choose any version ever published by the Free
|
||||||
|
Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future versions
|
||||||
|
of the GNU General Public License can be used, that proxy's public
|
||||||
|
statement of acceptance of a version permanently authorizes you to
|
||||||
|
choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
#### 15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
||||||
|
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
||||||
|
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
||||||
|
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
||||||
|
CORRECTION.
|
||||||
|
|
||||||
|
#### 16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
||||||
|
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
||||||
|
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
||||||
|
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
||||||
|
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
||||||
|
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
||||||
|
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
|
#### 17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
### How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these
|
||||||
|
terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest to
|
||||||
|
attach them to the start of each source file to most effectively state
|
||||||
|
the exclusion of warranty; and each file should have at least the
|
||||||
|
"copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper
|
||||||
|
mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands \`show w' and \`show c' should show the
|
||||||
|
appropriate parts of the General Public License. Of course, your
|
||||||
|
program's commands might be different; for a GUI interface, you would
|
||||||
|
use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or
|
||||||
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
|
necessary. For more information on this, and how to apply and follow
|
||||||
|
the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your
|
||||||
|
program into proprietary programs. If your program is a subroutine
|
||||||
|
library, you may consider it more useful to permit linking proprietary
|
||||||
|
applications with the library. If this is what you want to do, use the
|
||||||
|
GNU Lesser General Public License instead of this License. But first,
|
||||||
|
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
34
docs/release.md
Normal file
34
docs/release.md
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
Release procedure
|
||||||
|
=================
|
||||||
|
|
||||||
|
This document is a checklist for creating a toot release.
|
||||||
|
|
||||||
|
Currently the process is pretty manual and would benefit from automatization.
|
||||||
|
|
||||||
|
Bump & tag version
|
||||||
|
------------------
|
||||||
|
|
||||||
|
* Update the version number in `setup.py`
|
||||||
|
* Update the version number in `toot/__init__.py`
|
||||||
|
* Update `changelog.yaml` with the release notes & date
|
||||||
|
* Run `make changelog` to generate a human readable changelog
|
||||||
|
* Commit the changes
|
||||||
|
* Run `./scripts/tag_version <version>` to tag a release in git
|
||||||
|
* Run `git push --follow-tags` to upload changes and tag to GitHub
|
||||||
|
|
||||||
|
Publishing to PyPI
|
||||||
|
------------------
|
||||||
|
|
||||||
|
* `make dist` to create source and wheel distributions
|
||||||
|
* `make publish` to push them to PyPI
|
||||||
|
|
||||||
|
GitHub release
|
||||||
|
--------------
|
||||||
|
|
||||||
|
* [Create a release](https://github.com/ihabunek/toot/releases/) for the newly
|
||||||
|
pushed tag, paste changelog since last tag in the description
|
||||||
|
* Upload the assets generated in previous two steps to the release:
|
||||||
|
* source dist (.zip and .tar.gz)
|
||||||
|
* wheel distribution (.whl)
|
||||||
|
|
||||||
|
TODO: this can be automated: https://developer.github.com/v3/repos/releases/
|
||||||
BIN
docs/trumpet.png
Normal file
BIN
docs/trumpet.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
47
docs/tui.md
Normal file
47
docs/tui.md
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
TUI
|
||||||
|
===
|
||||||
|
|
||||||
|
toot includes a
|
||||||
|
[text-based user interface](https://en.wikipedia.org/wiki/Text-based_user_interface).
|
||||||
|
Start it by running `toot tui`.
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
[](https://asciinema.org/a/563459)
|
||||||
|
|
||||||
|
## Keyboard shortcuts
|
||||||
|
|
||||||
|
Pressing `H` will bring up the help screen where all keyboard shortcuts are
|
||||||
|
listed.
|
||||||
|
|
||||||
|
**Navigation**
|
||||||
|
|
||||||
|
* `Arrow keys` or `H/J/K/L` to move around and scroll content
|
||||||
|
* `PageUp` and `PageDown` to scroll content
|
||||||
|
* `Enter` or `Space` to activate buttons and menu options
|
||||||
|
* `Esc` or `Q` to go back, close overlays and menus
|
||||||
|
|
||||||
|
**General**
|
||||||
|
|
||||||
|
* `Q` - quit toot
|
||||||
|
* `G` - go to - switch timelines
|
||||||
|
* `P` - save/unsave (pin) current timeline
|
||||||
|
* `,` - refresh current timeline
|
||||||
|
* `H` - show this help
|
||||||
|
|
||||||
|
**Status**
|
||||||
|
|
||||||
|
These commands are applied to the currently focused status.
|
||||||
|
|
||||||
|
* `B` - Boost/unboost status
|
||||||
|
* `C` - Compose new status
|
||||||
|
* `F` - Favourite/unfavourite status
|
||||||
|
* `K` - Bookmark/unbookmark status
|
||||||
|
* `N` - Translate status if possible (toggle)
|
||||||
|
* `R` - Reply to current status
|
||||||
|
* `S` - Show text marked as sensitive
|
||||||
|
* `T` - Show status thread (replies)
|
||||||
|
* `L` - Show the status links
|
||||||
|
* `U` - Show the status data in JSON as received from the server
|
||||||
|
* `V` - Open status in default browser
|
||||||
|
* `Z` - Open status in scrollable popup window
|
||||||
176
docs/usage.md
Normal file
176
docs/usage.md
Normal file
|
|
@ -0,0 +1,176 @@
|
||||||
|
Usage
|
||||||
|
=====
|
||||||
|
|
||||||
|
Running `toot` displays a list of available commands.
|
||||||
|
|
||||||
|
Running `toot <command> -h` shows the documentation for the given command.
|
||||||
|
|
||||||
|
Below is an overview of some common scenarios.
|
||||||
|
|
||||||
|
<!-- toc -->
|
||||||
|
|
||||||
|
Authentication
|
||||||
|
--------------
|
||||||
|
|
||||||
|
Before tooting, you need to log into a Mastodon instance.
|
||||||
|
|
||||||
|
toot login
|
||||||
|
|
||||||
|
You will be redirected to your Mastodon instance to log in and authorize toot to
|
||||||
|
access your account, and will be given an **authorization code** in return
|
||||||
|
which you need to enter to log in.
|
||||||
|
|
||||||
|
The application and user access tokens will be saved in the configuration file
|
||||||
|
located at `~/.config/toot/config.json`.
|
||||||
|
|
||||||
|
### Using multiple accounts
|
||||||
|
|
||||||
|
It's possible to be logged into multiple accounts at the same time. Just
|
||||||
|
repeat the login process for another instance. You can see all logged in
|
||||||
|
accounts by running `toot auth`. The currently active account will have an
|
||||||
|
**ACTIVE** flag next to it.
|
||||||
|
|
||||||
|
To switch accounts, use `toot activate`. Alternatively, most commands accept a
|
||||||
|
`--using` option which can be used to specify the account you wish to use just
|
||||||
|
that one time.
|
||||||
|
|
||||||
|
Finally you can logout from an account by using `toot logout`. This will
|
||||||
|
remove the stored access tokens for that account.
|
||||||
|
|
||||||
|
Post a status
|
||||||
|
-------------
|
||||||
|
|
||||||
|
The simplest action is posting a status.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot post "hello there"
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also pipe in the status text:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
echo "Text to post" | toot post
|
||||||
|
cat post.txt | toot post
|
||||||
|
toot post < post.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
If no status text is given, you will be prompted to enter some:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ toot post
|
||||||
|
Write or paste your toot. Press Ctrl-D to post it.
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally, you can launch your favourite editor:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot post --editor vim
|
||||||
|
```
|
||||||
|
|
||||||
|
Define your editor preference in the `EDITOR` environment variable, then you
|
||||||
|
don't need to specify it explicitly:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
export EDITOR=vim
|
||||||
|
toot post --editor
|
||||||
|
```
|
||||||
|
|
||||||
|
### Attachments
|
||||||
|
|
||||||
|
You can attach media to your status. Mastodon supports images, video and audio
|
||||||
|
files. For details on supported formats see
|
||||||
|
[Mastodon docs on attachments](https://docs.joinmastodon.org/user/posting/#attachments).
|
||||||
|
|
||||||
|
It is encouraged to add a plain-text description to the attached media for
|
||||||
|
accessibility purposes by adding a `--description` option.
|
||||||
|
|
||||||
|
To attach an image:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot post "hello media" --media path/to/image.png --description "Cool image"
|
||||||
|
```
|
||||||
|
|
||||||
|
You can attach upto 4 attachments by giving multiple `--media` and
|
||||||
|
`--description` options:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot post "hello media" \
|
||||||
|
--media path/to/image1.png --description "First image" \
|
||||||
|
--media path/to/image2.png --description "Second image" \
|
||||||
|
--media path/to/image3.png --description "Third image" \
|
||||||
|
--media path/to/image4.png --description "Fourth image"
|
||||||
|
```
|
||||||
|
|
||||||
|
The order of options is not relevant, except that the first given media will be
|
||||||
|
matched to the first given description and so on.
|
||||||
|
|
||||||
|
If the media is sensitive, mark it as such and people will need to click to show
|
||||||
|
it. This affects all attachments.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot post "naughty pics ahoy" --media nsfw.png --sensitive
|
||||||
|
```
|
||||||
|
|
||||||
|
View timeline
|
||||||
|
-------------
|
||||||
|
|
||||||
|
View what's on your home timeline:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot timeline
|
||||||
|
```
|
||||||
|
|
||||||
|
Timeline takes various options:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot timeline --public # public timeline
|
||||||
|
toot timeline --public --local # public timeline, only this instance
|
||||||
|
toot timeline --tag photo # posts tagged with #photo
|
||||||
|
toot timeline --count 5 # fetch 5 toots (max 20)
|
||||||
|
toot timeline --once # don't prompt to fetch more toots
|
||||||
|
```
|
||||||
|
|
||||||
|
Add `--help` to see all the options.
|
||||||
|
|
||||||
|
Status actions
|
||||||
|
--------------
|
||||||
|
|
||||||
|
The timeline lists the status ID at the bottom of each toot. Using that status
|
||||||
|
you can do various actions to it, e.g.:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot favourite 123456
|
||||||
|
toot reblog 123456
|
||||||
|
```
|
||||||
|
|
||||||
|
If it's your own status you can also delete pin or delete it:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot pin 123456
|
||||||
|
toot delete 123456
|
||||||
|
```
|
||||||
|
|
||||||
|
Account actions
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Find a user by their name or account name:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot search "name surname"
|
||||||
|
toot search @someone
|
||||||
|
toot search someone@someplace.social
|
||||||
|
```
|
||||||
|
|
||||||
|
Once found, follow them:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot follow someone@someplace.social
|
||||||
|
```
|
||||||
|
|
||||||
|
If you get bored of them:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
toot mute someone@someplace.social
|
||||||
|
toot block someone@someplace.social
|
||||||
|
toot unfollow someone@someplace.social
|
||||||
|
```
|
||||||
Loading…
Reference in a new issue