From a24b310c5ba17b194d1be7f8e38a0f0b58fe728d Mon Sep 17 00:00:00 2001 From: spla Date: Sat, 27 Aug 2022 13:05:15 +0200 Subject: [PATCH] Changed README.rst to README.md --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 50 -------------------------------------------------- 2 files changed, 50 insertions(+), 50 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..a19fe00 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Mastodonplus.py +Fork of Python wrapper for the 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. diff --git a/README.rst b/README.rst deleted file mode 100644 index 8776fca..0000000 --- a/README.rst +++ /dev/null @@ -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. -