From 615f88154c7455299e5f0b8a31f300d0a9d72ea4 Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Thu, 24 Nov 2016 02:07:08 +0100 Subject: Further readjustment. Docs now actually build, but look bad. --- Mastodon.py | 356 --------------------------------------------------- docs/Makefile | 225 ++++++++++++++++++++++++++++++++ docs/conf.py | 348 ++++++++++++++++++++++++++++++++++++++++++++++++- docs/contents.rst | 1 - docs/index.rst | 17 ++- mastodon/Mastodon.py | 353 ++++++++++++++++++++++++++++++++++++++++++++++++++ mastodon/__init__.py | 2 + 7 files changed, 937 insertions(+), 365 deletions(-) delete mode 100644 Mastodon.py create mode 100644 docs/Makefile delete mode 100644 docs/contents.rst create mode 100644 mastodon/Mastodon.py create mode 100644 mastodon/__init__.py diff --git a/Mastodon.py b/Mastodon.py deleted file mode 100644 index 6b83a6e..0000000 --- a/Mastodon.py +++ /dev/null @@ -1,356 +0,0 @@ -# coding: utf-8 - -import requests -import os -import os.path - -class Mastodon: - """ - Super basic but thorough and easy to use mastodon.social - api wrapper in python. - - If anything is unclear, check the official API docs at - https://github.com/Gargron/mastodon/wiki/API - - Presently, only username-password login is supported, somebody please - patch in Real Proper OAuth if desired. - - KNOWN BUGS: Media api does not work, reason unclear. - """ - __DEFAULT_BASE_URL = 'https://mastodon.social' - - ### - # Registering apps - ### - @staticmethod - def create_app(client_name, scopes = ['read', 'write', 'follow'], redirect_uris = None, to_file = None, api_base_url = __DEFAULT_BASE_URL): - """ - Creates a new app with given client_name and scopes (read, write, follow) - - Specify redirect_uris if you want users to be redirected to a certain page after authenticating. - Specify to_file to persist your apps info to a file so you can use them in the constructor. - Specify api_base_url if you want to register an app on an instance different from the flagship one. - - Returns client_id and client_secret. - """ - request_data = { - 'client_name': client_name, - 'scopes': " ".join(scopes) - } - - if redirect_uris != None: - request_data['redirect_uris'] = redirect_uris; - else: - request_data['redirect_uris'] = 'urn:ietf:wg:oauth:2.0:oob'; - - response = requests.post(api_base_url + '/api/v1/apps', data = request_data).json() - - if to_file != None: - with open(to_file, 'w') as secret_file: - secret_file.write(response['client_id'] + '\n') - secret_file.write(response['client_secret'] + '\n') - - return (response['client_id'], response['client_secret']) - - ### - # Authentication, including constructor - ### - def __init__(self, client_id, client_secret = None, access_token = None, api_base_url = __DEFAULT_BASE_URL): - """ - Creates a new API wrapper instance based on the given client_secret and client_id. If you - give a client_id and it is not a file, you must also give a secret. - - You can also directly specify an access_token, directly or as a file. - - Specify api_base_url if you wish to talk to an instance other than the flagship one. - If a file is given as client_id, read client ID and secret from that file - """ - self.api_base_url = api_base_url - self.client_id = client_id - self.client_secret = client_secret - self.access_token = access_token - - if os.path.isfile(self.client_id): - with open(self.client_id, 'r') as secret_file: - self.client_id = secret_file.readline().rstrip() - self.client_secret = secret_file.readline().rstrip() - else: - if self.client_secret == None: - raise ValueError('Specified client id directly, but did not supply secret') - - if self.access_token != None and os.path.isfile(self.access_token): - with open(self.access_token, 'r') as token_file: - self.access_token = token_file.readline().rstrip() - - def log_in(self, username, password, scopes = ['read', 'write', 'follow'], to_file = None): - """ - Logs in and sets access_token to what was returned. - Can persist access token to file. - - Returns the access_token, as well. - """ - params = self.__generate_params(locals()) - params['client_id'] = self.client_id - params['client_secret'] = self.client_secret - params['grant_type'] = 'password' - params['scope'] = " ".join(scopes) - - response = self.__api_request('POST', '/oauth/token', params) - self.access_token = response['access_token'] - - if to_file != None: - with open(to_file, 'w') as token_file: - token_file.write(response['access_token'] + '\n') - - return response['access_token'] - - ### - # Reading data: Timelines - ## - def timeline(self, timeline = 'home', max_id = None, since_id = None, limit = None): - """ - Returns statuses, most recent ones first. Timeline can be home, mentions, public - or tag/:hashtag - """ - params = self.__generate_params(locals(), ['timeline']) - return self.__api_request('GET', '/api/v1/timelines/' + timeline, params) - - ### - # Reading data: Statuses - ### - def status(self, id): - """ - Returns a status. - """ - return self.__api_request('GET', '/api/v1/statuses/' + str(id)) - - def status_context(self, id): - """ - Returns ancestors and descendants of the status. - """ - return self.__api_request('GET', '/api/v1/statuses/' + str(id) + '/context') - - def status_reblogged_by(self, id): - """ - Returns a list of users that have reblogged a status. - """ - return self.__api_request('GET', '/api/v1/statuses/' + str(id) + '/reblogged_by') - - def status_favourited_by(self, id): - """ - Returns a list of users that have favourited a status. - """ - return self.__api_request('GET', '/api/v1/statuses/' + str(id) + '/favourited_by') - - ### - # Reading data: Accounts - ### - def account(self, id): - """ - Returns account. - """ - return self.__api_request('GET', '/api/v1/accounts/' + str(id)) - - def account_verify_credentials(self): - """ - Returns authenticated user's account. - """ - return self.__api_request('GET', '/api/v1/accounts/verify_credentials') - - def account_statuses(self, id, max_id = None, since_id = None, limit = None): - """ - Returns statuses by user. Same options as timeline are permitted. - """ - params = self.__generate_params(locals(), ['id']) - return self.__api_request('GET', '/api/v1/accounts/' + str(id) + '/statuses') - - def account_following(self, id): - """ - Returns users the given user is following. - """ - return self.__api_request('GET', '/api/v1/accounts/' + str(id) + '/following') - - def account_followers(self, id): - """ - Returns users the given user is followed by. - """ - return self.__api_request('GET', '/api/v1/accounts/' + str(id) + '/followers') - - def account_relationships(self, id): - """ - Returns relationships (following, followed_by, blocking) of the logged in user to - a given account. id can be a list. - """ - params = self.__generate_params(locals()) - return self.__api_request('GET', '/api/v1/accounts/relationships', params) - - def account_suggestions(self): - """ - Returns accounts that the system suggests the authenticated user to follow. - """ - return self.__api_request('GET', '/api/v1/accounts/suggestions') - - def account_search(self, q, limit = None): - """ - Returns matching accounts. Will lookup an account remotely if the search term is - in the username@domain format and not yet in the database. - """ - params = self.__generate_params(locals()) - return self.__api_request('GET', '/api/v1/accounts/search', params) - - ### - # Writing data: Statuses - ### - def status_post(self, status, in_reply_to_id = None, media_ids = None): - """ - Posts a status. Can optionally be in reply to another status and contain - up to four pieces of media (Uploaded via media_post()). - - Returns the new status. - """ - params = self.__generate_params(locals()) - return self.__api_request('POST', '/api/v1/statuses', params) - - def toot(self, status): - """ - Synonym for status_post that only takes the status text as input. - """ - return self.status_post(status) - - def status_delete(self, id): - """ - Deletes a status - """ - return self.__api_request('DELETE', '/api/v1/statuses/' + str(id)) - - def status_reblog(self, id): - """Reblogs a status. - - Returns a new status that wraps around the reblogged one.""" - return self.__api_request('POST', '/api/v1/statuses/' + str(id) + "/reblog") - - def status_unreblog(self, id): - """ - Un-reblogs a status. - - Returns the status that used to be reblogged. - """ - return self.__api_request('POST', '/api/v1/statuses/' + str(id) + "/unreblog") - - def status_favourite(self, id): - """ - Favourites a status. - - Returns the favourited status. - """ - return self.__api_request('POST', '/api/v1/statuses/' + str(id) + "/favourite") - - def status_unfavourite(self, id): - """Favourites a status. - - Returns the un-favourited status. - """ - return self.__api_request('POST', '/api/v1/statuses/' + str(id) + "/unfavourite") - - ### - # Writing data: Statuses - ### - def account_follow(self, id): - """ - Follows a user. - - Returns the updated relationship to the user. - """ - return self.__api_request('POST', '/api/v1/accounts/' + str(id) + "/follow") - - def account_unfollow(self, id): - """ - Unfollows a user. - - Returns the updated relationship to the user. - """ - return self.__api_request('POST', '/api/v1/accounts/' + str(id) + "/unfollow") - - def account_block(self, id): - """ - Blocks a user. - - Returns the updated relationship to the user. - """ - return self.__api_request('POST', '/api/v1/accounts/' + str(id) + "/block") - - def account_unblock(self, id): - """ - Unblocks a user. - - Returns the updated relationship to the user. - """ - return self.__api_request('POST', '/api/v1/accounts/' + str(id) + "/unblock") - - ### - # Writing data: Media - ### - def media_post(self, media_file): - """ - Posts an image. media_file can either be image data or - a file name. - - Returns the ID of the media that can then be used in status_post(). - """ - if os.path.isfile(media_file): - media_file = open(media_file, 'rb') - - return self.__api_request('POST', '/api/v1/media', files = {'file': media_file}) - - ### - # Internal helpers, dragons probably - ### - def __api_request(self, method, endpoint, params = {}, files = {}): - """ - Internal API request helper. - """ - response = None - headers = None - - if self.access_token != None: - headers = {'Authorization': 'Bearer ' + self.access_token} - - if method == 'GET': - response = requests.get(self.api_base_url + endpoint, data = params, headers = headers, files = files) - - if method == 'POST': - response = requests.post(self.api_base_url + endpoint, data = params, headers = headers, files = files) - - if method == 'DELETE': - response = requests.delete(self.api_base_url + endpoint, data = params, headers = headers, files = files) - - if response.status_code == 404: - raise IOError('Endpoint not found.') - - if response.status_code == 500: - raise IOError('General API problem.') - - return response.json() - - def __generate_params(self, params, exclude = []): - """ - Internal named-parameters-to-dict helper. - """ - params = dict(params) - - del params['self'] - param_keys = list(params.keys()) - for key in param_keys: - if params[key] == None or key in exclude: - del params[key] - - param_keys = list(params.keys()) - for key in param_keys: - if isinstance(params[key], list): - params[key + "[]"] = params[key] - del params[key] - - return params - - - diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..fae2b97 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,225 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Mastodonpy.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Mastodonpy.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Mastodonpy" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Mastodonpy" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/conf.py b/docs/conf.py index 86f9db8..3ccb5ed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,346 @@ -import sys -import os +# -*- coding: utf-8 -*- +# +# Mastodon.py documentation build configuration file, created by +# sphinx-quickstart on Thu Nov 24 01:25:38 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' -extensions = ['sphinx.ext.autodoc'] +import os +import sys sys.path.insert(0, os.path.abspath('../')) -sys.path.insert(0, os.path.abspath('../../')) +#print(sys.path) + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Mastodon.py' +copyright = u'2016, Lorenz Diener' +author = u'Lorenz Diener' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'0.9' +# The full version, including alpha/beta/rc tags. +release = u'0.9' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# " v documentation" by default. +# +# html_title = u'Mastodon.py v0.9' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +# html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Mastodonpydoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Mastodonpy.tex', u'Mastodon.py Documentation', + u'Lorenz Diener', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# +# latex_use_parts = False + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# It false, will not define \strong, \code, itleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'mastodonpy', u'Mastodon.py Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Mastodonpy', u'Mastodon.py Documentation', + author, 'Mastodonpy', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False diff --git a/docs/contents.rst b/docs/contents.rst deleted file mode 100644 index fb1d2ad..0000000 --- a/docs/contents.rst +++ /dev/null @@ -1 +0,0 @@ -.. toctree:: diff --git a/docs/index.rst b/docs/index.rst index 30d8f1e..1334538 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,16 @@ -Mastodon.py -=========== +.. Mastodon.py documentation master file, created by + sphinx-quickstart on Thu Nov 24 01:25:38 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. -Python wrapper for the Mastodon ( https://github.com/Gargron/mastodon/ ) API. +Welcome to Mastodon.py's documentation! +======================================= +Contents: + +.. toctree:: + :maxdepth: 2 + +.. py:currentmodule:: mastodon .. autoclass:: Mastodon - :members: \ No newline at end of file + :members: diff --git a/mastodon/Mastodon.py b/mastodon/Mastodon.py new file mode 100644 index 0000000..8d54455 --- /dev/null +++ b/mastodon/Mastodon.py @@ -0,0 +1,353 @@ +# coding: utf-8 + +import requests +import os +import os.path + +class Mastodon: + """ + Super basic but thorough and easy to use mastodon.social + api wrapper in python. + + If anything is unclear, check the official API docs at + https://github.com/Gargron/mastodon/wiki/API + + Presently, only username-password login is supported, somebody please + patch in Real Proper OAuth if desired. + + KNOWN BUGS: Media api does not work, reason unclear. + """ + __DEFAULT_BASE_URL = 'https://mastodon.social' + + ### + # Registering apps + ### + @staticmethod + def create_app(client_name, scopes = ['read', 'write', 'follow'], redirect_uris = None, to_file = None, api_base_url = __DEFAULT_BASE_URL): + """ + Creates a new app with given client_name and scopes (read, write, follow) + + Specify redirect_uris if you want users to be redirected to a certain page after authenticating. + Specify to_file to persist your apps info to a file so you can use them in the constructor. + Specify api_base_url if you want to register an app on an instance different from the flagship one. + + Returns client_id and client_secret. + """ + request_data = { + 'client_name': client_name, + 'scopes': " ".join(scopes) + } + + if redirect_uris != None: + request_data['redirect_uris'] = redirect_uris; + else: + request_data['redirect_uris'] = 'urn:ietf:wg:oauth:2.0:oob'; + + response = requests.post(api_base_url + '/api/v1/apps', data = request_data).json() + + if to_file != None: + with open(to_file, 'w') as secret_file: + secret_file.write(response['client_id'] + '\n') + secret_file.write(response['client_secret'] + '\n') + + return (response['client_id'], response['client_secret']) + + ### + # Authentication, including constructor + ### + def __init__(self, client_id, client_secret = None, access_token = None, api_base_url = __DEFAULT_BASE_URL): + """ + Creates a new API wrapper instance based on the given client_secret and client_id. If you + give a client_id and it is not a file, you must also give a secret. + + You can also directly specify an access_token, directly or as a file. + + Specify api_base_url if you wish to talk to an instance other than the flagship one. + If a file is given as client_id, read client ID and secret from that file + """ + self.api_base_url = api_base_url + self.client_id = client_id + self.client_secret = client_secret + self.access_token = access_token + + if os.path.isfile(self.client_id): + with open(self.client_id, 'r') as secret_file: + self.client_id = secret_file.readline().rstrip() + self.client_secret = secret_file.readline().rstrip() + else: + if self.client_secret == None: + raise ValueError('Specified client id directly, but did not supply secret') + + if self.access_token != None and os.path.isfile(self.access_token): + with open(self.access_token, 'r') as token_file: + self.access_token = token_file.readline().rstrip() + + def log_in(self, username, password, scopes = ['read', 'write', 'follow'], to_file = None): + """ + Logs in and sets access_token to what was returned. + Can persist access token to file. + + Returns the access_token, as well. + """ + params = self.__generate_params(locals()) + params['client_id'] = self.client_id + params['client_secret'] = self.client_secret + params['grant_type'] = 'password' + params['scope'] = " ".join(scopes) + + response = self.__api_request('POST', '/oauth/token', params) + self.access_token = response['access_token'] + + if to_file != None: + with open(to_file, 'w') as token_file: + token_file.write(response['access_token'] + '\n') + + return response['access_token'] + + ### + # Reading data: Timelines + ## + def timeline(self, timeline = 'home', max_id = None, since_id = None, limit = None): + """ + Returns statuses, most recent ones first. Timeline can be home, mentions, public + or tag/:hashtag + """ + params = self.__generate_params(locals(), ['timeline']) + return self.__api_request('GET', '/api/v1/timelines/' + timeline, params) + + ### + # Reading data: Statuses + ### + def status(self, id): + """ + Returns a status. + """ + return self.__api_request('GET', '/api/v1/statuses/' + str(id)) + + def status_context(self, id): + """ + Returns ancestors and descendants of the status. + """ + return self.__api_request('GET', '/api/v1/statuses/' + str(id) + '/context') + + def status_reblogged_by(self, id): + """ + Returns a list of users that have reblogged a status. + """ + return self.__api_request('GET', '/api/v1/statuses/' + str(id) + '/reblogged_by') + + def status_favourited_by(self, id): + """ + Returns a list of users that have favourited a status. + """ + return self.__api_request('GET', '/api/v1/statuses/' + str(id) + '/favourited_by') + + ### + # Reading data: Accounts + ### + def account(self, id): + """ + Returns account. + """ + return self.__api_request('GET', '/api/v1/accounts/' + str(id)) + + def account_verify_credentials(self): + """ + Returns authenticated user's account. + """ + return self.__api_request('GET', '/api/v1/accounts/verify_credentials') + + def account_statuses(self, id, max_id = None, since_id = None, limit = None): + """ + Returns statuses by user. Same options as timeline are permitted. + """ + params = self.__generate_params(locals(), ['id']) + return self.__api_request('GET', '/api/v1/accounts/' + str(id) + '/statuses') + + def account_following(self, id): + """ + Returns users the given user is following. + """ + return self.__api_request('GET', '/api/v1/accounts/' + str(id) + '/following') + + def account_followers(self, id): + """ + Returns users the given user is followed by. + """ + return self.__api_request('GET', '/api/v1/accounts/' + str(id) + '/followers') + + def account_relationships(self, id): + """ + Returns relationships (following, followed_by, blocking) of the logged in user to + a given account. id can be a list. + """ + params = self.__generate_params(locals()) + return self.__api_request('GET', '/api/v1/accounts/relationships', params) + + def account_suggestions(self): + """ + Returns accounts that the system suggests the authenticated user to follow. + """ + return self.__api_request('GET', '/api/v1/accounts/suggestions') + + def account_search(self, q, limit = None): + """ + Returns matching accounts. Will lookup an account remotely if the search term is + in the username@domain format and not yet in the database. + """ + params = self.__generate_params(locals()) + return self.__api_request('GET', '/api/v1/accounts/search', params) + + ### + # Writing data: Statuses + ### + def status_post(self, status, in_reply_to_id = None, media_ids = None): + """ + Posts a status. Can optionally be in reply to another status and contain + up to four pieces of media (Uploaded via media_post()). + + Returns the new status. + """ + params = self.__generate_params(locals()) + return self.__api_request('POST', '/api/v1/statuses', params) + + def toot(self, status): + """ + Synonym for status_post that only takes the status text as input. + """ + return self.status_post(status) + + def status_delete(self, id): + """ + Deletes a status + """ + return self.__api_request('DELETE', '/api/v1/statuses/' + str(id)) + + def status_reblog(self, id): + """Reblogs a status. + + Returns a new status that wraps around the reblogged one.""" + return self.__api_request('POST', '/api/v1/statuses/' + str(id) + "/reblog") + + def status_unreblog(self, id): + """ + Un-reblogs a status. + + Returns the status that used to be reblogged. + """ + return self.__api_request('POST', '/api/v1/statuses/' + str(id) + "/unreblog") + + def status_favourite(self, id): + """ + Favourites a status. + + Returns the favourited status. + """ + return self.__api_request('POST', '/api/v1/statuses/' + str(id) + "/favourite") + + def status_unfavourite(self, id): + """Favourites a status. + + Returns the un-favourited status. + """ + return self.__api_request('POST', '/api/v1/statuses/' + str(id) + "/unfavourite") + + ### + # Writing data: Statuses + ### + def account_follow(self, id): + """ + Follows a user. + + Returns the updated relationship to the user. + """ + return self.__api_request('POST', '/api/v1/accounts/' + str(id) + "/follow") + + def account_unfollow(self, id): + """ + Unfollows a user. + + Returns the updated relationship to the user. + """ + return self.__api_request('POST', '/api/v1/accounts/' + str(id) + "/unfollow") + + def account_block(self, id): + """ + Blocks a user. + + Returns the updated relationship to the user. + """ + return self.__api_request('POST', '/api/v1/accounts/' + str(id) + "/block") + + def account_unblock(self, id): + """ + Unblocks a user. + + Returns the updated relationship to the user. + """ + return self.__api_request('POST', '/api/v1/accounts/' + str(id) + "/unblock") + + ### + # Writing data: Media + ### + def media_post(self, media_file): + """ + Posts an image. media_file can either be image data or + a file name. + + Returns the ID of the media that can then be used in status_post(). + """ + if os.path.isfile(media_file): + media_file = open(media_file, 'rb') + + return self.__api_request('POST', '/api/v1/media', files = {'file': media_file}) + + ### + # Internal helpers, dragons probably + ### + def __api_request(self, method, endpoint, params = {}, files = {}): + """ + Internal API request helper. + """ + response = None + headers = None + + if self.access_token != None: + headers = {'Authorization': 'Bearer ' + self.access_token} + + if method == 'GET': + response = requests.get(self.api_base_url + endpoint, data = params, headers = headers, files = files) + + if method == 'POST': + response = requests.post(self.api_base_url + endpoint, data = params, headers = headers, files = files) + + if method == 'DELETE': + response = requests.delete(self.api_base_url + endpoint, data = params, headers = headers, files = files) + + if response.status_code == 404: + raise IOError('Endpoint not found.') + + if response.status_code == 500: + raise IOError('General API problem.') + + return response.json() + + def __generate_params(self, params, exclude = []): + """ + Internal named-parameters-to-dict helper. + """ + params = dict(params) + + del params['self'] + param_keys = list(params.keys()) + for key in param_keys: + if params[key] == None or key in exclude: + del params[key] + + param_keys = list(params.keys()) + for key in param_keys: + if isinstance(params[key], list): + params[key + "[]"] = params[key] + del params[key] + + return params diff --git a/mastodon/__init__.py b/mastodon/__init__.py new file mode 100644 index 0000000..0c0744e --- /dev/null +++ b/mastodon/__init__.py @@ -0,0 +1,2 @@ +from Mastodon import Mastodon +__all__ = ['Mastodon'] -- cgit v1.2.3