Changed README.rst to README.md

This commit is contained in:
spla 2022-08-27 13:05:15 +02:00
pare e33166f025
commit a24b310c5b
S'han modificat 2 arxius amb 50 adicions i 50 eliminacions

50
README.md Normal file
Veure arxiu

@ -0,0 +1,50 @@
# Mastodonplus.py
Fork of Python wrapper for the Mastodon (<https://github.com/tootsuite/mastodon/> ) API.
The goal of this fork is to add all 'new' Mastodon API's endpoints to the excellent [halcy's wrapper](https://github.com/halcy/Mastodon.py).
## 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://your-mastodon.server>\'
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://your-mastodon.server'
)
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://your-mastodon.server>'
)
mastodon.toot('Tooting from python using #mastodonpy !')
```
You can install Mastodonplus.py via pypi:
```
# Python 3
pip3 install Mastodonplus.py
```
## New features
* 26.8.2022. Added New endpoints: /api/v1/admin/domain_blocks (list,show by id, delete and create)
* 27.8.2022. Mastodon v3.1.4. Added 'remote" param to GET /api/v1/timelines/public REST API.

Veure arxiu

@ -1,50 +0,0 @@
Mastodonplus.py
===========
Fork of Python wrapper for the Mastodon ( https://github.com/tootsuite/mastodon/ ) API.
This fork's goal is to add new Mastodon API's endpoints to the excellent halcy's wrapper.
# 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://your-mastodon.server',
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://your-mastodon.server'
)
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://your-mastodon.server'
)
mastodon.toot('Tooting from python using #mastodonpy !')
You can install Mastodonplus.py via pypi:
# Python 3
pip3 install Mastodonplus.py
# New features
* 26.8.2022. Added New endpoints: /api/v1/admin/domain_blocks (list, show by id, delete and create)
* 27.8.2022. Mastodon v3.1.4. Added 'remote" param to GET /api/v1/timelines/public REST API.