Python wrapper for the Mastodon (https://github.com/mastodon/mastodon) API.
Go to file
Lorenz Diener 82f531e3ee Add reactions to changelog 2020-02-29 18:52:20 +01:00
docs Add reactions to changelog 2020-02-29 18:52:20 +01:00
mastodon Add reaction support 2020-02-29 18:48:01 +01:00
tests Add bookmarks test 2020-02-22 20:37:54 +01:00
.gitignore Update .gitignore to ignore pytest cache 2019-10-11 22:08:52 +02:00
.travis.yml Sunset 2.7 2019-07-23 12:16:23 +02:00
CHANGELOG.rst Add reactions to changelog 2020-02-29 18:52:20 +01:00
DEVELOPMENT.md Add reactions to changelog 2020-02-29 18:52:20 +01:00
LICENSE Update LICENSE to reflect that this is not a single person project 2019-05-31 12:57:38 +02:00
MANIFEST.in Update MANIFEST.in 2018-05-06 01:46:42 +02:00
Pipfile Update Pipfile 2020-02-21 21:03:21 +01:00
Pipfile.lock Doc fixes, remove some broken code, note about blocks 2019-07-23 12:08:21 +02:00
README.rst the usual: hey readthedocs here's the new tag 2019-10-12 23:31:05 +02:00
setup.cfg add coverage reports to tests 2017-11-27 00:39:53 +01:00
setup.py 1.5.0 changelog and version bumps 2019-10-12 23:20:28 +02:00
tox.ini Sunset 2.7 2019-07-23 12:16:57 +02:00

README.rst

Mastodon.py
===========
Python wrapper for the Mastodon ( https://github.com/tootsuite/mastodon/ ) API.
Feature complete for public API as of Mastodon version 3.0.1 and easy to get started with:

.. code-block:: python

    # Register your app! This only needs to be done once. Uncomment the code and substitute in your information.
    
    from mastodon import Mastodon

    '''
    Mastodon.create_app(
         'pytooterapp',
         api_base_url = 'https://mastodon.social',
         to_file = 'pytooter_clientcred.secret'
    )
    '''

    # Then login. This can be done every time, or use persisted.

    from mastodon import Mastodon
    
    mastodon = Mastodon(
        client_id = 'pytooter_clientcred.secret',
        api_base_url = 'https://mastodon.social'
    )
    mastodon.log_in(
        'my_login_email@example.com',
        'incrediblygoodpassword',
        to_file = 'pytooter_usercred.secret'
    )

    # To post, create an actual API instance.

    from mastodon import Mastodon
    
    mastodon = Mastodon(
        access_token = 'pytooter_usercred.secret',
        api_base_url = 'https://mastodon.social'
    )
    mastodon.toot('Tooting from python using #mastodonpy !')

You can install Mastodon.py via pypi:

.. code-block:: Bash
   
   # Python 3
   pip3 install Mastodon.py

Note that python 2.7 is now no longer officially supported. It will still 
work for a while, and we will fix issues as they come up, but we will not 
be testing specifically for python 2.7 any longer.

Full documentation and basic usage examples can be found 
at http://mastodonpy.readthedocs.io/en/stable/ .

Acknowledgements
----------------
Mastodon.py contains work by a large amount of contributors, many of which have
put significant work into making it a better library. You can find some information
about who helped with which particular feature or fix in the changelog. 

.. image:: https://travis-ci.org/halcy/Mastodon.py.svg?branch=master
    :target: https://travis-ci.org/halcy/Mastodon.py
.. image:: https://codecov.io/gh/halcy/Mastodon.py/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/halcy/Mastodon.py