Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
A simple Python wrapper for Twitter API v2 ✨ 🍰 ✨
License
sns-sdks/python-twitter
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.rst
A simple Python wrapper for Twitter API v2 ✨ 🍰 ✨ .
Twitter has published new version Twitter API V2 for developer at Aug 13, 2020.
This library provides a service to easily use this new version Twitter API.
You can get all API descriptions Twitter API v2 Documentation.
You can install this library easily by pypi:
$ pip install python-twitter-v2
Checkout latest development version with:
$ git clone https://github.com/sns-sdks/python-twitter.git $ cd python-twitter Install dependencies with:
$ make cov-term $ make cov-html
The API is exposed via the pytwitter.Api class.
Now covers these features:
- Tweets
- Tweet lookup
- Manage Tweets
- Quote Tweets
- Timelines
- Search Tweets
- Tweet counts
- Filtered stream
- Volume streams
- Retweets
- Likes
- Bookmarks
- Hide replies
- User lookup
- Follows
- Blocks
- Mutes
- Spaces lookup
- Search Spaces
- Batch compliance
- List lookup
- Manage lists
- List Tweets lookup
- List members
- List follows
- Pinned Lists
- Direct Messages lookup
- Manage Direct Messages
You can initialize with an bearer token:
>>> from pytwitter import Api >>> api = Api(bearer_token="Your bearer token")
With OAuth 1.0A user context token:
>>> api = Api( consumer_key="consumer key", consumer_secret="consumer secret", access_token="access token", access_secret="access secret" )
Or with authorization done by user:
>>> api = Api(consumer_key="consumer key",consumer_secret="consumer secret",oauth_flow=True) # get url for user to authorize >>> api.get_authorize_url() # copy the response url >>> api.generate_access_token("https://localhost/?oauth_token=oauth_token&oauth_verifier=oauth_verifier") 'oauth_token': 'oauth_token', 'oauth_token_secret': 'oauth_token_secret', 'user_id': '123456', 'screen_name': 'screen name'>
Now if you have app with OAuth2.0 client ID. you can do authorize with OAuth2 .
>>> api = Api(client_id="You client ID", oauth_flow=True) # get the url and code verifier for user to authorize >>> url, code_verifier, _ = api.get_oauth2_authorize_url() # copy the response url >>> api.generate_oauth2_access_token("https://localhost/?state=state&code=code", code_verifier) 'token_type': 'bearer', 'expires_in': 7200, 'access_token': 'access_token', 'scope': 'users.read tweet.read', 'expires_at': 1631775928>
You can get information about a user or group of users, specified by a user ID or a username.
# By ids >>> api.get_users(ids=["783214", "2244994945"]) Response(data=[User(id='2244994945', name='Twitter Dev', username='TwitterDev'), User(id='783214', name='Twitter', username='Twitter')]) # By username >>> api.get_users(usernames="Twitter,TwitterDev") Response(data=[User(id='2244994945', name='Twitter Dev', username='TwitterDev'), User(id='783214', name='Twitter', username='Twitter')])
# By id >>> api.get_user(user_id="783214") Response(data=User(id='783214', name='Twitter', username='Twitter')) # By username >>> api.get_user(username="Twitter") Response(data=User(id='783214', name='Twitter', username='Twitter'))
>>> api.get_following(user_id="2244994945", max_results=5) Response(data=[User(id='459860328', name='julie✨', username='JulieMendoza206'), User(id='273830767', name='🄿🅄🅂🄷', username='rahul_pushkarna'). ])
>>> api.get_followers(user_id="2244994945", max_results=5) Response(data=[User(id='715131097332518912', name='Daniel', username='RGIDaniel'), User(id='1176323137757048832', name='Joyce Wang', username='joycew67'). ])
You can follow or unfollow user if you have User context.
>>> api.follow_user(user_id="123456", target_user_id="654321") 'data': 'following': True, 'pending_follow': False>>
>>> api.unfollow_user(user_id="123456", target_user_id="654321") 'data': 'following': False>>
You can get information about a tweet or group of tweets by tweet id(s).
>>> api.get_tweet("1354143047324299264", expansions=["attachments.media_keys"], media_fields=["type","duration_ms"]) Response(data=Tweet(id=1354143047324299264, text=Academics are one of the biggest groups using. ))
>>> api.get_tweets(["1261326399320715264","1278347468690915330"],expansions="author_id",tweet_fields=["created_at"], user_fields=["username","verified"]) Response(data=[Tweet(id=1261326399320715264, text=Tune in to the @MongoDB @Twitch stream. ), Tweet(id=1278347468690915330, text=Good news and bad news: 2020 is half over)])
For Streaming, this provide StreamApi independent. Same as main Api, You need initialize it first.
>>> from pytwitter import StreamApi >>> stream_api = StreamApi(bearer_token="bearer token") # or use consumer key and secret >>> stream_api = StreamApi(consumer_key="consumer key", consumer_secret="consumer secret")
For Sample Stream tweets, you can use the sample_stream function to build a connection.
For Filtered Stream, you can create rules.
>>> stream_api.get_rules() Response(data=[StreamRule(id='1369580714056843266', value='twitter api ')])
>>> stream_api.manage_rules(rules="delete": "ids": ["1369580714056843266"]>>) Response(data=[])
Add new rules. If you set dry_run to True, will only validate rules, and not create them.
>>> np = < "add": [ "value": "cat has:media", "tag": "cats with media">, "value": "cat has:media -grumpy", "tag": "happy cats with media"> ] > >>> stream_api.manage_rules(rules=np, dry_run=True) Response(data=[StreamRule(id='1370406958721732610', value='cat has:media -grumpy'), StreamRule(id='1370406958721732609', value='cat has:media')])
Then you can use search_stream to get tweets matching your rules.
You can go to the Example folder for streaming examples.