Python wrapper for the Mastodon ( https://github.com/mastodon/mastodon/ ) API.
 
 
Go to file
Lorenz Diener 29e976bbb0 This is just the javascript code, will port later 2019-05-08 18:45:24 +02:00
docs Bump Mastodon version in some places 2019-05-08 18:08:11 +02:00
mastodon Bump Mastodon version in some places 2019-05-08 18:08:11 +02:00
tests Oops I forgot to commit the polls test 2019-04-29 17:36:07 +02:00
.gitignore
.travis.yml
CHANGELOG.rst Release prep 2019-04-28 23:22:09 +02:00
DEVELOPMENT.md
LICENSE
MANIFEST.in
Pipfile add test for link headers. this adds requests-mock as a dependency 2019-04-15 15:52:30 +02:00
Pipfile.lock Update Pipfile.lock to ensure all the dependencies are safe 2019-04-27 18:03:33 +02:00
README.rst Bump Mastodon version in some places 2019-05-08 18:08:11 +02:00
blurhash.py This is just the javascript code, will port later 2019-05-08 18:45:24 +02:00
setup.cfg
setup.py Release prep 2019-04-28 23:22:09 +02:00
tox.ini Add pipenv and tox file, 2.7 is broken rn 2018-11-18 04:58:33 -05: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 2.8.2 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 2
   pip install Mastodon.py
   
   # Python 3
   pip3 install Mastodon.py

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