From 39bdc5d10a956e4859c304bee35e89e4d647a602 Mon Sep 17 00:00:00 2001 From: halcy Date: Sun, 23 Apr 2023 19:02:49 +0300 Subject: [PATCH] Add usage examples --- CHANGELOG.rst | 8 +++++++- README.rst | 3 ++- docs/index.rst | 4 ++++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index e0320af..80e5182 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,11 +2,17 @@ A note on versioning: This librarys major version will grow with the APIs version number. Breaking changes will be indicated by a change in the minor (or major) version number, and will generally be avoided. -v1.8.0 (in progress) +v1.8.1 (in progress) -------------------- * Replace some lambdas with list comprenehsions (thanks eumiro) * Add `resolve` keyword to `account_search` (thanks zevaryx) * Add support for user agent header in `create_app` (thanks jkawamoto) +* Update tox.ini for newer versions (thanks jkawamoto) +* Various doc and argument check fixes (thanks cnotin, codl, alexmshepherd) +* Fix magic not working on windows (thanks xloem) +* Add readme to PyPi page (thanks hugovk) +* Fix `list_accounts` to actually include request parameters (thanks leoncowle) +* Small formatting changes (thanks amaargiru) v1.8.0 ------ diff --git a/README.rst b/README.rst index 85262bf..abae973 100644 --- a/README.rst +++ b/README.rst @@ -43,7 +43,8 @@ We currently try to support Python 3.7 and above, and try to at least not break below that. Python 2 support is no longer a goal. Full documentation and basic usage examples can be found -at https://mastodonpy.readthedocs.io/en/stable/ +at https://mastodonpy.readthedocs.io/en/stable/ . Some more extensive examples can be +found at https://github.com/halcy/MastodonpyExamples Acknowledgements ---------------- diff --git a/docs/index.rst b/docs/index.rst index 5b1fe3a..b4e4758 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -55,6 +55,10 @@ as forks, while not an official target, should also be basically compatible, and Mastodon.py does make some allowances for behaviour that isn't strictly like that of Mastodon, and attempts to support extensions to the API. +Some usage examples (not neccesarily following app development best practices, +but enough to get you started if you learn best by example) can be found +at https://github.com/halcy/MastodonpyExamples + Acknowledgements ---------------- Mastodon.py contains work by a large number of contributors, many of which have