aboutsummaryrefslogblamecommitdiff
blob: 58fb9a966b33c13e230c7d04aa2044596d7b2ff4 (plain) (tree)
1
2
3
4
5
6
7
8
9

           
                      
 




                                


                                                 




                                                 



                                                

                                    

                                           


      
                               
                       


                                                 
    
                                                           
 
                                                                                
                                                                                          
 









                                     
                                                         
                                                
 





                                                                                   

                                                                    
                                                                                
                                                    

 
Mastodon.py
===========
.. code-block:: python

   from mastodon import Mastodon

   # Register app - only once!
   '''
   Mastodon.create_app(
        'pytooterapp',
        api_base_url = 'https://mastodon.social',
        to_file = 'pytooter_clientcred.secret'
   )
   '''

   # Log in - either every time, or use persisted
   '''
   mastodon = Mastodon(
       client_id = 'pytooter_clientcred.secret',
       api_base_url = 'https://mastodon.social'
   )
   mastodon.log_in(
       '[email protected]',
       'incrediblygoodpassword',
       to_file = 'pytooter_usercred.secret'
   )
   '''

   # Create actual API instance
   mastodon = Mastodon(
       client_id = 'pytooter_clientcred.secret', 
       access_token = 'pytooter_usercred.secret',
       api_base_url = 'https://mastodon.social'
   )
   mastodon.toot('Tooting from python using #mastodonpy !')

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

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/latest/ .

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
Powered by cgit v1.2.3 (git 2.41.0)