From 8e202fbdc069bcb8171b69b73c8ecac3dd043707 Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Fri, 16 Jun 2017 00:39:19 +0200 Subject: [PATCH] Some clarifications about api base URLs. --- docs/index.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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 every aspect. This is a simple python wrapper for that api, provided as a single python module. By default, it talks to the `Mastodon flagship instance`_, but it can be set to talk to any -node running Mastodon. +node running Mastodon by setting api_base_url when creating the +api object (or creating an app). A note about rate limits ------------------------ @@ -259,6 +260,11 @@ startup is not, so don't do that - instead, register an application once, and then persist your client id and secret. Convenience methods for this are provided. +To talk to an instance different from the flagship instance, specify +the api_base_url (usually, just the URL of the instance, i.e. +https://mastodon.social/ for the flagship instance). If no protocol +is specified, Mastodon.py defaults to https. + .. automethod:: Mastodon.create_app .. automethod:: Mastodon.__init__ .. automethod:: Mastodon.log_in