Mastodonplus.py/README.rst

68 líneas
2,1 KiB
ReStructuredText
Original Vista normal Històric

2016-11-24 20:55:54 +01:00
Mastodon.py
===========
Python wrapper for the Mastodon ( https://github.com/tootsuite/mastodon/ ) API.
2019-10-12 23:20:28 +02:00
Feature complete for public API as of Mastodon version 3.0.1 and easy to get started with:
2018-08-14 19:04:21 +02:00
.. code-block:: python
2019-06-22 23:29:46 +02:00
# Register your app! This only needs to be done once. Uncomment the code and substitute in your information.
2019-04-28 23:22:09 +02:00
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 !')
2016-11-23 23:30:51 +01:00
2016-11-24 21:03:18 +01:00
You can install Mastodon.py via pypi:
.. code-block:: Bash
# Python 3
pip3 install Mastodon.py
2019-07-23 12:37:28 +02:00
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.
2017-06-16 01:29:12 +02:00
Full documentation and basic usage examples can be found
2019-04-28 23:22:09 +02:00
at http://mastodonpy.readthedocs.io/en/stable/ .
2017-11-29 18:11:03 +01:00
2017-12-14 13:42:13 +01:00
Acknowledgements
2019-06-23 12:17:45 +02:00
----------------
2017-12-14 13:42:13 +01:00
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
2018-06-05 23:27:51 +02:00
about who helped with which particular feature or fix in the changelog.
2017-12-14 13:42:13 +01:00
2017-11-29 18:11:03 +01:00
.. image:: https://travis-ci.org/halcy/Mastodon.py.svg?branch=master
:target: https://travis-ci.org/halcy/Mastodon.py
2017-11-30 16:04:42 +01:00
.. image:: https://codecov.io/gh/halcy/Mastodon.py/branch/master/graph/badge.svg
2017-12-14 13:42:13 +01:00
:target: https://codecov.io/gh/halcy/Mastodon.py