Releases | Open Source Science

mastodon.py - v2.1.3

Fix the library throwing a deprecation warning during some internal operations due to the v1 version of the instance API being deprecated, add a fallback to the v1 API in case Mastodon actually removes the v1 endpoint in the future. (Thanks @andrew-codechimp for the report)
Fix "Everything" page in the docs

- Python
Published by halcy 6 months ago

mastodon.py - v2.1.2

Fix broken login when instancev2 is present but has no apiversions attribute, such as on e.g. GoToSocial. (Thank you @bfordham for the report and fix!)

- Python
Published by halcy 6 months ago

mastodon.py - v2.1.1

Fixed return type and docs for account_set_note.
Improved documentation in various places.
Added missing type annotations in utility.py.

- Python
Published by halcy 6 months ago

mastodon.py - v2.1.0

Bumped support level to 4.4.3
Fixed to_json breaking on python 3.14 (Thanks @limburgher for the report)
Replaced pytest-vcr (deprecated) with pytest-recording (Thanks @CyberTailor)
Improved timeline documentation (Thanks @adamse)
Improved docs for stream_healthy (thanks @codl)
Add offset parameter to trendingtags and trendinglinks (Thanks @ghost)
Added support for retrieving API version and a warning for if it is not present despite the mastodon version suggesting it should be.
Added support for retrieving OAuth authorization server info
Added check for supported password grant type based on authorization server info (Thanks @thisismissem for the suggestion)
Added support for alternate OAuth URLs based on the authorization server info
Added pagination iteraton via pagination_iterator (Thanks @FredericoCeratto for the suggestion)
Added a way to get pagination info out of lists that is slightly less digging-around-in-internals via get_pagination_info (Thanks @s427 for the inciting report)
Added missing replies_policy and exclusive parameters to list creation and update methods.
Add status length counter get_status_length (Thanks @yuletide for the suggestion and @cheeaun for the assistance)
Fix notifications returning nonsense when passing a single id (Thanks @chinchalinchin for the report)
Fix moved accidentally being named moved_to_account (Thanks @unusualevent for the report)
Added a warning for deprecated endpoints if the "deprecation" header is present
Added oauth_userinfo endpoint.
Added delete_media parameter to status_delete.
Added standard parameter to push_subscription_set.
Added attribution_domains parameter to account_update_credentials.
Added date_of_birth parameter to create_account.
Added account_endorse and account_unendorse methods (replacing "pin" methods)
Added tag_feature and tag_unfeature methods (replacing previous featured tag api)
Added instance_terms_of_service method.

- Python
Published by halcy 6 months ago

mastodon.py - v2.0.1

Maintenance release. Fixes a few minor, but important, issues

Remove spurious debug prints (Thanks aitorres)
Fix pagination fetch_remaining being broken due to typing changes (Thanks jikamens)
Fix pagination result parsing due to typing changes (Thanks hashier for the report)
Fix pagination information not being saved with to/from_json functions

Docs: https://mastodonpy.readthedocs.io/en/v2.0.1/ PyPi: https://pypi.org/project/Mastodon.py/2.0.1/

- Python
Published by halcy 12 months ago

This is a big release. Everything for 4.3.0 support has been added, a lot of refactoring has happened, the library is now fully typed. Backwards compatibility SHOULD have been maintained - no existing code should break - but please be extra careful about upgrading.

Absolutely massive rework of entities and typing. There are now proper classes for all entities, and typing is now used throughout the library. There is an attempt here to be backwards compatible, and none of my tests break.
Documentation fixes based on the new entities and typing.
Added information that streaming API access is now auth mandatory (Thanks @leahoswald)
Removed six dependency, since we don't care about 2.x anymore (Thanks @a-detiste)
Support level is now 4.3.0
Note that logging in with passwords is deprecated and to be removed in 4.4.0
Clarify the use of code (Thanks @lasseedfast)
Improved docstring for visibility (Thanks @ashwinvis)
Added offset parameter to trending_statuses (Thanks @Teqed)
We're now using space age technology (pyproject.toml - thanks @codl)
Add py.typed marker (Thanks @ZeeD for the suggestion)
Added CITATION.cff (Thanks @hauschke for the suggestion)
Fixed a potential issue with modification to locals (Thanks Konano)
Added support for 4.3.0 accounts endpoint (Thanks AlexKalopsia)
Fix version parsing for GoToSocial (Thanks gmemstr)
Updated docs to reflect the fact that startign with 4.4.0, the password grant type is no longer supported.
Added support for following tags (followed_tags, tag_follow, tag_unfollow, tag)
Fix library not working with -O2 (Thanks mirabilos for the report)
Version check mode now defaults to "none", since it keeps causing more problems than it solves.
Document media (Thanks LunarLambda for the report)
Added json serialization and deserialization for returned entities
Added missing event types and a catch-all event for streaming API
Add v1 and v2 variants for instance
Add canonical domain block support (admin_canonical_email_blocks, admin_canonical_email_block, admin_canonical_email_block_create, admin_canonical_email_block_delete)
Add trending link timeline (timeline_link)
Update suggestions endpoint and return value
Add withsuspended parameter to accountrelationships
Add forwardtodomains parameter to reports
Add account_delete_avatar and account_delete_header
Add statuses method to retrieve multiple statuses at once
Add automatic conversion of datetime objects to flake IDs for min/max/since_id fields where appropriate
Add notifications_unread_count
Add media attachment editing
Add email domain blocking support (admin_email_domain_blocks, admin_email_domain_block, admin_email_domain_block_create, admin_email_domain_block_delete)
Add instance_extended_description
Add instance_translation_languages, translation support (status_translate)
Add trend admin functions (admin_trending_tags, admin_trending_statuses, admin_trending_links, admin_approve_trending_link, admin_reject_trending_link, admin_approve_trending_status, admin_reject_trending_status, admin_approve_trending_tag, admin_reject_trending_tag)
Add admin IP block functions (admin_ip_blocks, admin_ip_block, admin_ip_block_create, admin_ip_block_delete)
Add instance_domain_blocks
Add notification policy and requests (notifications_policy, update_notifications_policy, notifications_requests, notification_request, accept_notification_request, reject_notification_request, notifications_merged, accept_multiple_notification_requests, dismiss_multiple_notification_requests)
Add instance_languages
Add notification grouping (grouped_notifications, grouped_notification, dismiss_grouped_notification, grouped_notification_accounts, unread_grouped_notifications_count)
Add v2 filer API (filters_v2, filter_v2, create_filter_v2, update_filter_v2, delete_filter_v2, filter_keywords_v2, add_filter_keyword_v2, delete_filter_keyword_v2, filter_statuses_v2, add_filter_status_v2, filter_status_v2, delete_filter_status_v2)
Docs: https://mastodonpy.readthedocs.io/en/2.0.0/ PyPi: https://pypi.org/project/Mastodon.py/2.0.0/

- Python
Published by halcy about 1 year ago

mastodon.py - 1.8.1

Maintenance release. No new features, fixes only.

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, RedactedCode)
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)
Add link to examples to docs and readme.
Add local and remote parameter to stream_public (thank you for the report jeafreezy)
Fix limit and lang parameters on trend related functions not present or working (thanks for the report pdeitel)
Fix some issues with stream reconnect handling (thanks for the report ianh)
Added an example for how to receive webpush notifications (thanks JesseWeinstein)
Replaced follows with a backwards compatibility stub.
Added pagination parameters to admin_domain_blocks (thanks for the report defnull)

Docs: https://mastodonpy.readthedocs.io/en/1.8.1/ PyPi: https://pypi.org/project/Mastodon.py/1.8.1/

- Python
Published by halcy almost 3 years ago

mastodon.py - 1.8.0

Overall: Support level is now 3.5.5 (last before 4.0.0)
BREAKING CHANGE: Switch the base URL to None, throw an error when no base url is passed. Having mastosoc as default was sensible when there were only three mastodon servers. It is not sensible now and trips people up constantly.
GENERAL WARNING: Currently, Mastodon.py does not support the "new" filter system. In the future, it will, and it will respect filters by default (i.e. remove filtered posts).
Fixed an issue with the fix for the Pleroma date bug (thanks adbenitez)
Added trending APIs (trending_tags, trending_statuses, trending_links, admin_trending_tags, admin_trending_statuses, admin_trending_links)
Added lang parameter and document what it does properly.
Added category and rule_ids to reports
Made the documentation a bit neater (thanks dieseltravis)
Added the domain blocking admin API (admin_domain_blocks, admin_domain_block, admin_update_domain_block, admin_delete_domain_block - thanks catgoat)
Added the stats admin APIs (admin_measures, admin_dimensions, admin_retention)
Added client auth data to access token file.
Added account_familiar_followers API
Added account_remove_from_followers API
Added admin_accounts_v2 API
FUTURE BREAKING CHANGE WARNING: For now, admin_accounts still calls v1, but this may change in the future. You are encouraged to use v2 instead.
Made the version comparisons a bit nicer (thanks eumiro)
Switch to more recent modules for datetime and timezone stuff (thanks eumiro)
Made the documentation a bit more consistent (thanks dieseltravis)
Substantially restructured the documentation, making it a lot nicer to read
Substantially restructured the code, making it hopefully a lot easier to maintain
- This SHOULD NOT break anything. If this breaks your code, please let me know.
This too isn't really a changelog entry but in the same vein as the last post, thank you Claire and Gargron for clarifying many things about the API when asked.

Docs: https://mastodonpy.readthedocs.io/en/1.8.0/ PyPi: https://pypi.org/project/Mastodon.py/1.8.0/

- Python
Published by halcy about 3 years ago

mastodon.py - 1.7.0

Cleaned code up a bit (thanks eumiro)
Fixed some Pleroma related issues (thanks aveao, taraletti, adbenitez)
Added post editing (status_update, status_source, status_history)
Added missing streaming events
Added missing parameters on directory endpoint (thanks heharkon)
This isn't somehing I changed but thank you a / triggerofsol for answering Many questions I had about specifics of what the API does that are not documented
Fixed search ignoring exclude_unreviewed (Thanks acidghost)
Added support for using pathlib paths when loading media files (Thanks reagle)
Removed blocklist with long dead instances
Added types parameter to notifications.
Documented additional notification types
Made version parsing more robust against varions things that Mastodon-compatible APIs might throw at it.
TECHNICALLY BREAKING CHANGE, but I would be quite surprised if this actually breaks anyone: Date parsing will now, when the date string is empty, return Jan. 1st, 1970 instead. This is to work around what I assume is a bug in Pleroma.
Docs: https://mastodonpy.readthedocs.io/en/1.7.0/
PyPi: https://pypi.org/project/Mastodon.py/1.7.0/

- Python
Published by halcy about 3 years ago

mastodon.py - 1.6.3

Add server rules API (instance_rules)
Add confirmation email resend API (email_resend_confirmation)
Add account lookup API (account_lookup)
Add policy param to control notification sources for push_subscription_set
Add ability to get detailed signup error to create_account
Fix version check for limited federation instances (Thanks to ulysseus-eu for the report)
(From 1.6.2, untagged) Fix some issues with datetime conversion (thanks to various people for reporting it)

Docs: https://mastodonpy.readthedocs.io/en/1.6.3/ PyPi: https://pypi.org/manage/project/Mastodon.py/release/1.6.3/

- Python
Published by halcy over 3 years ago

mastodon.py - 1.6.1

BREAKING CHANGE: Change behaviour of streaming api handlers to no longer raise an exception when an unknown event is received and change the contract of the unknown event handler to explicitly state that it will not receive events once Mastodon.py updates.
3.1.3 support
- Added v2 media_post api
3.1.4 support
- Added "remote", "local" and "only_media" parameter for timelines more broadly
- Documented updates to instance information api return value
3.2.0 support
- Added account notes API
- Added thumbnail support to mediapost / mediaupdate
- Documented new keys in media API
3.3.0 support
- Added "notify" parameter for following.
- Added support for timed mutes
- Added support for getting an accounts features tags via accountfeaturedtags
Miscelaneous additions
- Added support for paginating by date via converting dates to snowflake IDs (on Mastodon only - thanks to edent for the suggestion)
- Added a method to revoke oauth tokens (thanks fluffy-critter)
Fixes
- Various small and big fixes, improving reliablity and test coverage
- Changed health APIs to work with newer Mastodon versions
- Changed URLs from "tootsuite" to "mastodon" in several places (thanks andypiper)
- Fixed some fields not converting to datetimes (thanks SouthFox-D)
- Improved oauth web flow support
- Improved documentation consistency (thanks andypiper)

Docs: https://mastodonpy.readthedocs.io/en/1.6.1/ PyPi: https://pypi.org/project/Mastodon.py/1.6.1/

- Python
Published by halcy over 3 years ago

mastodon.py - 1.5.2

BREAKING CHANGE: Greatly improve how pagination info is stored (arittner)
Add "unknown event" handler for streaming (arittner)
Add support for exclude_types in notifications api (MicroCheapFx)
Add pagination to bookmarks (arittner)
Make connecting for streaming more resilient (arittner)
Allow specifying a user agent header (arittner)
Add support for tagged and excludereblogs on accountstatuses api (arittner)
Add support for reports without attached statuses (arittner)
General fixes
- Fix a typo in _jsonfruefalse_parse (zen-tools)
Some non-mastodon related fixes
- Fix a typo in error message for content_type (rinpatch
- Add support for specifying file name when uploading (animeavi)
- Fix several crashes related to gotosocials version string (fwaggle)
- Fix an issue related to hometowns version string

Docs: https://mastodonpy.readthedocs.io/en/1.5.2/ Pip: https://pypi.org/project/Mastodon.py/1.5.2/

- Python
Published by halcy over 3 years ago

mastodon.py - 1.5.1

3.1 support
- Added discoverable parameter to accountupdatecredentials (Thanks gdunstone)
- Added new notification type "follow_request"
- Added bookmarks support:
  - New functions: statusbookmark, statusunbookmark, bookmarks
  - New fine-grained oauth scopes: read:bookmarks and write:bookmarks.
- Added announcement support
  - New functions: announcements, announcement_dismiss
- Added announcement reaction support
  - New functions: announcementreactioncreate, announcementreactiondelete
Fixed missing notification type "poll" in push notification API and documentation.´
Fixed a token loading bug
Fix header upload in accountupdatecredentials (Thanks gdunstone)
Commented blocklist code (Thanks marnanel for the report)
Added fallback for when magic is not available (Thanks limburgher)
Added missing "mentions_only" parameter to notifications (Thanks adbenitez for the report)
Moved "content_type" parameter into "pleroma" feature set. This is a breaking change.

Docs: https://mastodonpy.readthedocs.io/en/1.5.1/ Pip: https://pypi.org/project/Mastodon.py/1.5.1/

- Python
Published by halcy almost 6 years ago

mastodon.py - 1.5.0

3.0.0 support release (actually bumps supported version to 3.0.1, though), with some additional improvements

BREAKING CHANGE: the search_v1 API is now gone from Mastodon, Mastodon.py will still let you use it where available / use it where needed if you call search()
Support for new 3.0.0 features
- Added profile directory API: directory()
- Added featured and suggested tags API: featuredtags(), featuredtagsuggestions(), featuredtagcreate(), featuredtag_delete() (Thanks Gargron for the advice)
- Added read-markers API: markersget(), markersset()
- Re-added trends API: trends()
- Added health api: instance_health()
- Added nodeinfo support: instance_nodeinfo()
- Added new parameters to search (excludeunreviewed) and createaccount (reason)
Added ability to persist base URLs together with access token and client id / secret files
Documented that status_card endpoint has been removed, switched to alternate method of retrieving cards if function is still used
Added blurhash as a core dependency, since it is now licensed permissively again
Added me() function as synonym for accountverifycredentials() to lessen confusion
Fixed notification-dismiss to use new API endpoint where the old one is not available (Thanks kensanata)
Fixed statusreply to match statuspost
Add basic support for non-mainline featuresvia the feature_set parameter
- Added support for fedibirds quoteid parameter in statuspost
Future-proofed webpush cryptography api while trying to remain very backwards compatible so that it can hopefully in the future become part of the core
Clarified and updated the documentation and improved the tests in various ways

Docs: https://mastodonpy.readthedocs.io/en/1.5.0/ PyPi: https://pypi.org/project/Mastodon.py/1.5.0/