https://github.com/calmery/pawopy

A Python wrapper for the Mastodon API like tweepy
https://github.com/calmery/pawopy

mastodon mastodon-api python

Last synced: about 19 hours ago
JSON representation

A Python wrapper for the Mastodon API like tweepy

• Host: GitHub
• URL: https://github.com/calmery/pawopy
• Owner: calmery
• Archived: true
• Created: 2017-04-21T18:17:42.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-11T08:01:11.000Z (over 7 years ago)
• Last Synced: 2024-05-23T04:02:49.757Z (8 months ago)
• Topics: mastodon, mastodon-api, python
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pawopy

A Python wrapper for the Mastodon API like tweepy

### Installation

```

$ pip install pawopy

```

```python

import pawopy

auth = pawopy.OAuthHandler( 'https://pawoo.net' )

auth.set_access_token( access_token )

api = pawopy.API( auth )

api.update_status( 'Hello World !' )

```

### Authorization

```python

import pawopy

auth = pawopy.OAuthHandler( 'https://pawoo.net' )

url = auth.get_authorization_url()

code = input( url + '\n> ' )

access_token = auth.get_access_token( code )

api = pawopy.API( auth )

```

```python

import pawopy

auth = pawopy.PasswordAuthHandler( 'https://pawoo.net' )

access_token = auth.get_access_token( user_name, password )

api = pawopy.API( auth )

```

### Methods

```python

api.get( path [, params] )

api.post( path [, params] )

api.delete( path [, params] )

# Example

api.get( 'timelines/home' )

```

It mayn't work because it hasn't done enough test...

```python

# Timeline

api.home_timeline()

api.public_timeline()

# User

api.me()

api.favorites()

api.get_user( user_id )

api.following( [user_id] )

api.followers( [user_id] )

# Relationship

api.create_friendship( user_id )

api.destroy_friendship( user_id )

api.blocks()

api.create_block( user_id )

api.destroy_block( user_id )

api.mutes()

api.create_mute( user_id )

api.destroy_mute( user_id )

api.show_relationship( user_id )

api.follow_requests()

api.authorize( user_id )

api.reject( user_id )

# Notification

api.notifications()

api.get_notification( notification_id )

api.clear_notifications()

# Toot

api.update_status( text )

api.update_status_advanced( params )

'''

params {

  status

  in_reply_to_id (optional)

  media_ids (optional)

  sensitive (optional)

  spoiler_text (optional)

  visibility

}

'''

api.destroy_status( toot_id )

api.reblog( toot_id )

api.unreblog( toot_id )

api.create_favorite( toot_id )

api.destroy_favorite( toot_id )

api.get_status( toot_id )

api.get_status_reblogged_by( toot_id )

api.get_status_favorited_by( toot_id )

# Search

api.search( params )

'''

params {

  q

}

'''

api.search_user( params )

'''

params {

  q

  limit

}

'''

```

### Streaming

```python

from pawopy import OAuthHandler, Stream, StreamListener

auth = pawopy.OAuthHandler( 'https://pawoo.net' )

auth.set_access_token( access_token )

api = pawopy.API( auth )

class PawopyListener( StreamListener ) :

  def on_update( self, toot ) :

    print( toot.content )

  def on_notification( self, _ ) :

    pass

  def on_delete( self, _ ) :

    pass

stream = Stream( auth=api, listener=PawopyListener() )

stream.user_stream()

```