Python wrapper for the Mastodon (https://github.com/mastodon/mastodon) API.
Anar al arxiu
Lorenz Diener 2aa798a206
Update CHANGELOG.rst
2019-05-11 01:26:10 +02:00
docs Bump version number 2019-05-11 01:15:06 +02:00
mastodon Merge branch 'master' of https://github.com/halcy/Mastodon.py 2019-05-11 01:00:32 +02:00
tests Add previously forgotten test 2019-05-11 01:22:55 +02:00
.gitignore Add requirement for python-magic, and add wrappers to Mastodon.py 2018-11-12 09:44:57 -05:00
.travis.yml Revert "travis: only notify when a build starts failing, not every time" 2017-11-29 02:42:07 +01:00
CHANGELOG.rst Update CHANGELOG.rst 2019-05-11 01:26:10 +02:00
DEVELOPMENT.md Add webpush support 2018-06-05 14:10:53 +02:00
LICENSE Initial commit 2016-11-23 23:29:30 +01:00
MANIFEST.in Update MANIFEST.in 2018-05-06 01:46:42 +02:00
Pipfile add test for link headers. this adds requests-mock as a dependency 2019-04-15 15:52:30 +02:00
Pipfile.lock Release prep 2019-05-11 01:22:18 +02:00
README.rst Bump Mastodon version in some places 2019-05-08 18:08:11 +02:00
setup.cfg add coverage reports to tests 2017-11-27 00:39:53 +01:00
setup.py Bump version number 2019-05-11 01:15:06 +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