diff options
author | Lorenz Diener <[email protected]> | 2017-06-16 00:39:19 +0200 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2017-06-16 00:39:19 +0200 |
commit | 8e202fbdc069bcb8171b69b73c8ecac3dd043707 (patch) | |
tree | 6aa2f339824c4a2103eaecb16ab3eebaaa46efcd | |
parent | df98fc263e5e4dd80e1ead574fbd4c72e92ee12c (diff) | |
download | mastodon.py-8e202fbdc069bcb8171b69b73c8ecac3dd043707.tar.gz |
Some clarifications about api base URLs.
-rw-r--r-- | docs/index.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 09808ac..de14554 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -42,7 +42,8 @@ network node. It has an API that allows you to interact with its | |||
42 | every aspect. This is a simple python wrapper for that api, provided | 42 | every aspect. This is a simple python wrapper for that api, provided |
43 | as a single python module. By default, it talks to the | 43 | as a single python module. By default, it talks to the |
44 | `Mastodon flagship instance`_, but it can be set to talk to any | 44 | `Mastodon flagship instance`_, but it can be set to talk to any |
45 | node running Mastodon. | 45 | node running Mastodon by setting api_base_url when creating the |
46 | api object (or creating an app). | ||
46 | 47 | ||
47 | A note about rate limits | 48 | A note about rate limits |
48 | ------------------------ | 49 | ------------------------ |
@@ -259,6 +260,11 @@ startup is not, so don't do that - instead, register an application | |||
259 | once, and then persist your client id and secret. Convenience | 260 | once, and then persist your client id and secret. Convenience |
260 | methods for this are provided. | 261 | methods for this are provided. |
261 | 262 | ||
263 | To talk to an instance different from the flagship instance, specify | ||
264 | the api_base_url (usually, just the URL of the instance, i.e. | ||
265 | https://mastodon.social/ for the flagship instance). If no protocol | ||
266 | is specified, Mastodon.py defaults to https. | ||
267 | |||
262 | .. automethod:: Mastodon.create_app | 268 | .. automethod:: Mastodon.create_app |
263 | .. automethod:: Mastodon.__init__ | 269 | .. automethod:: Mastodon.__init__ |
264 | .. automethod:: Mastodon.log_in | 270 | .. automethod:: Mastodon.log_in |