aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst47
1 files changed, 36 insertions, 11 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 14ec49f..a8181b1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -37,7 +37,7 @@ Mastodon.py
37 ) 37 )
38 mastodon.toot('Tooting from python using #mastodonpy !') 38 mastodon.toot('Tooting from python using #mastodonpy !')
39 39
40`Mastodon`_ is an ostatus based twitter-like federated social 40`Mastodon`_ is an ActivityPub and OStatus based twitter-like federated social
41network node. It has an API that allows you to interact with its 41network node. It has an API that allows you to interact with its
42every aspect. This is a simple python wrapper for that api, provided 42every aspect. This is a simple python wrapper for that api, provided
43as a single python module. By default, it talks to the 43as a single python module. By default, it talks to the
@@ -112,23 +112,23 @@ Error handling
112When Mastodon.py encounters an error, it will raise an exception, generally with 112When Mastodon.py encounters an error, it will raise an exception, generally with
113some text included to tell you what went wrong. 113some text included to tell you what went wrong.
114 114
115The base class that all mastodon exceptions inherit from is the MastodonError 115The base class that all mastodon exceptions inherit from is `MastodonError`.
116class. If you are only interested in the fact an error was raised somewhere in 116If you are only interested in the fact an error was raised somewhere in
117Mastodon.py, and not the details, this is the exception you can catch. 117Mastodon.py, and not the details, this is the exception you can catch.
118 118
119MastodonIllegalArgumentError is generally a programming problem - you asked the 119`MastodonIllegalArgumentError` is generally a programming problem - you asked the
120API to do something obviously invalid (i.e. specify a privacy scope that does 120API to do something obviously invalid (i.e. specify a privacy scope that does
121not exist). 121not exist).
122 122
123MastodonFileNotFoundError and MastodonNetworkError are IO errors - could be you 123`MastodonFileNotFoundError` and `MastodonNetworkError` are IO errors - could be you
124specified a wrong URL, could be the internet is down or your hard drive is 124specified a wrong URL, could be the internet is down or your hard drive is
125dying. They inherit from MastodonIOError, for easy catching. 125dying. They inherit from MastodonIOError, for easy catching.
126 126
127MastodonAPIError is an error returned from the Mastodon instance - the server 127`MastodonAPIError` is an error returned from the Mastodon instance - the server
128has decided it can't fullfill your request (i.e. you requested info on a user that 128has decided it can't fullfill your request (i.e. you requested info on a user that
129does not exist). 129does not exist).
130 130
131MastodonRatelimitError is raised when you hit an API rate limit. You should try 131`MastodonRatelimitError` is raised when you hit an API rate limit. You should try
132again after a while (see the rate limiting section above). 132again after a while (see the rate limiting section above).
133 133
134Return values 134Return values
@@ -172,7 +172,7 @@ Toot dicts
172 'uri': # Descriptor for the toot 172 'uri': # Descriptor for the toot
173 # EG 'tag:mastodon.social,2016-11-25:objectId=<id>:objectType=Status' 173 # EG 'tag:mastodon.social,2016-11-25:objectId=<id>:objectType=Status'
174 'url': # URL of the toot 174 'url': # URL of the toot
175 'account': # Account dict for the account which posted the status 175 'account': # User dict for the account which posted the status
176 'in_reply_to_id': # Numerical id of the toot this toot is in response to 176 'in_reply_to_id': # Numerical id of the toot this toot is in response to
177 'in_reply_to_account_id': # Numerical id of the account this toot is in response to 177 'in_reply_to_account_id': # Numerical id of the account this toot is in response to
178 'reblog': # Denotes whether the toot is a reblog 178 'reblog': # Denotes whether the toot is a reblog
@@ -531,10 +531,35 @@ Streaming
531--------- 531---------
532These functions allow access to the streaming API. 532These functions allow access to the streaming API.
533 533
534.. automethod:: Mastodon.user_stream 534If async is False, these methods block forever (or until an
535.. automethod:: Mastodon.public_stream 535exception is raised).
536.. automethod:: Mastodon.hashtag_stream
537 536
537If async is True, the listener will listen on another thread and these methods
538will return a handle corresponding to the open connection. The
539connection may be closed at any time by calling its close() method.
540
541The streaming functions take instances of `StreamListener` as a parameter.
542A `CallbackStreamListener` class that allows you to specify function callbacks
543directly is included for convenience.
544
545.. automethod:: Mastodon.stream_user
546.. automethod:: Mastodon.stream_public
547.. automethod:: Mastodon.stream_local
548.. automethod:: Mastodon.stream_hashtag
549
550StreamListener
551~~~~~~~~~~~~~~
552
553.. autoclass:: StreamListener
554.. automethod:: StreamListener.on_update
555.. automethod:: StreamListener.on_notification
556.. automethod:: StreamListener.on_delete
557.. automethod:: StreamListener.handle_heartbeat
558
559CallbackStreamListener
560~~~~~~~~~~~~~~~~~~~~~~
561
562.. autoclass:: CallbackStreamListener
538 563
539.. _Mastodon: https://github.com/tootsuite/mastodon 564.. _Mastodon: https://github.com/tootsuite/mastodon
540.. _Mastodon flagship instance: http://mastodon.social/ 565.. _Mastodon flagship instance: http://mastodon.social/
Powered by cgit v1.2.3 (git 2.41.0)