Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
@d60
d60 authored Apr 8, 2024
1 parent aaaa4cf commit 4469ac2
Show file tree
Hide file tree
Showing 12 changed files with 104 additions and 104 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ client.create_tweet(

```

** Search the latest tweets based on a keywords**
**Search the latest tweets based on a keywords**
```python
tweets = client.search_tweet('python', 'Latest')

Expand Down
60 changes: 30 additions & 30 deletions twikit/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ def search_tweet(
Returns
-------
:class:`Result`[:class:`Tweet`]
Result[:class:`Tweet`]
An instance of the `Result` class containing the
search results.
Expand Down Expand Up @@ -515,7 +515,7 @@ def search_user(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
An instance of the `Result` class containing the
search results.
Expand Down Expand Up @@ -739,7 +739,7 @@ def create_poll(
Parameters
----------
choices : :class:`list`[:class:`str`]
choices : list[:class:`str`]
A list of choices for the poll. Maximum of 4 choices.
duration_minutes : :class:`int`
The duration of the poll in minutes.
Expand Down Expand Up @@ -848,7 +848,7 @@ def create_tweet(
----------
text : :class:`str`, default=''
The text content of the tweet.
media_ids : :class:`list`[:class:`str`], default=None
media_ids : list[:class:`str`], default=None
A list of media IDs or URIs to attach to the tweet.
media IDs can be obtained by using the `upload_media` method.
poll_uri : :class:`str`, default=None
Expand Down Expand Up @@ -979,7 +979,7 @@ def create_scheduled_tweet(
The timestamp when the tweet should be scheduled for posting.
text : :class:`str`, default=''
The text content of the tweet, by default an empty string.
media_ids : :class:`list`[:class:`str`], default=None
media_ids : list[:class:`str`], default=None
A list of media IDs to be attached to the tweet, by default None.
Returns
Expand Down Expand Up @@ -1283,7 +1283,7 @@ def get_scheduled_tweets(self) -> list[ScheduledTweet]:
Returns
-------
:class:`list`[:class:`ScheduledTweet`]
list[:class:`ScheduledTweet`]
List of ScheduledTweet objects representing the scheduled tweets.
"""
params = flatten_params({
Expand Down Expand Up @@ -1390,7 +1390,7 @@ def get_retweeters(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of users who retweeted the tweet.
Examples
Expand Down Expand Up @@ -1425,7 +1425,7 @@ def get_favoriters(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of users who favorited the tweet.
Examples
Expand Down Expand Up @@ -1468,7 +1468,7 @@ def get_user_tweets(
Returns
-------
:class:`Result`[:class:`Tweet`]
Result[:class:`Tweet`]
A Result object containing a list of `Tweet` objects.
Examples
Expand Down Expand Up @@ -1606,14 +1606,14 @@ def get_timeline(
----------
count : int, default=20
The number of tweets to retrieve.
seen_tweet_ids : :class:`list`[:class:`str`], default=None
seen_tweet_ids : list[:class:`str`], default=None
A list of tweet IDs that have been seen.
cursor : :class:`str`, default=None
A cursor for pagination.
Returns
-------
:class:`Result`[:class:`Tweet`]
Result[:class:`Tweet`]
A Result object containing a list of Tweet objects.
Example
Expand Down Expand Up @@ -1688,14 +1688,14 @@ def get_latest_timeline(
----------
count : int, default=20
The number of tweets to retrieve.
seen_tweet_ids : :class:`list`[:class:`str`], default=None
seen_tweet_ids : list[:class:`str`], default=None
A list of tweet IDs that have been seen.
cursor : :class:`str`, default=None
A cursor for pagination.
Returns
-------
:class:`Result`[:class:`Tweet`]
Result[:class:`Tweet`]
A Result object containing a list of Tweet objects.
Example
Expand Down Expand Up @@ -1977,7 +1977,7 @@ def get_bookmarks(
Returns
-------
:class:`Result`[:class:`Tweet`]
Result[:class:`Tweet`]
A Result object containing a list of Tweet objects
representing bookmarks.
Expand Down Expand Up @@ -2293,7 +2293,7 @@ def get_trends(
Returns
-------
:class:`list`[:class:`Trend`]
list[:class:`Trend`]
A list of Trend objects representing the retrieved trends.
Examples
Expand Down Expand Up @@ -2398,7 +2398,7 @@ def get_user_followers(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of User objects representing the followers.
"""
return self._get_user_friendship(
Expand All @@ -2423,7 +2423,7 @@ def get_user_verified_followers(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of User objects representing the verified followers.
"""
return self._get_user_friendship(
Expand All @@ -2448,7 +2448,7 @@ def get_user_followers_you_know(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of User objects representing the followers you might know.
"""
return self._get_user_friendship(
Expand All @@ -2473,7 +2473,7 @@ def get_user_following(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of User objects representing the users being followed.
"""
return self._get_user_friendship(
Expand All @@ -2498,7 +2498,7 @@ def get_user_subscriptions(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of User objects representing the subscribed users.
"""
return self._get_user_friendship(
Expand Down Expand Up @@ -2755,7 +2755,7 @@ def get_dm_history(
Returns
-------
:class:`Result`[:class:`Message`]
Result[:class:`Message`]
A Result object containing a list of Message objects representing
the DM conversation history.
Expand Down Expand Up @@ -2869,7 +2869,7 @@ def get_group_dm_history(
Returns
-------
:class:`Result`[:class:`GroupMessage`]
Result[:class:`GroupMessage`]
A Result object containing a list of GroupMessage objects
representing the DM conversation history.
Expand Down Expand Up @@ -2945,7 +2945,7 @@ def add_members_to_group(
----------
group_id : :class:`str`
ID of the group to which the member is to be added.
user_ids : :class:`list`[:class:`str`]
user_ids : list[:class:`str`]
List of IDs of users to be added.
Returns
Expand Down Expand Up @@ -3017,7 +3017,7 @@ def create_list(
Returns
-------
:class:`List`
list
The created list.
Examples
Expand Down Expand Up @@ -3137,7 +3137,7 @@ def edit_list(
Returns
-------
:class:`List`
list
The updated Twitter list.
Examples
Expand Down Expand Up @@ -3253,7 +3253,7 @@ def get_lists(
Returns
-------
:class:`Result`[:class:`List`]
Result[:class:`List`]
Retrieved lists.
Examples
Expand Down Expand Up @@ -3345,7 +3345,7 @@ def get_list_tweets(
Returns
-------
:class:`Result`[:class:`Tweet`]
Result[:class:`Tweet`]
A Result object containing the retrieved tweets.
Examples
Expand Down Expand Up @@ -3455,7 +3455,7 @@ def get_list_members(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
Members of a list
Examples
Expand Down Expand Up @@ -3490,7 +3490,7 @@ def get_list_subscribers(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
Subscribers of a list
Examples
Expand Down Expand Up @@ -3532,7 +3532,7 @@ def get_notifications(
Returns
-------
:class:`Result`[:class:`Notification`]
Result[:class:`Notification`]
List of retrieved notifications.
Examples
Expand Down
6 changes: 3 additions & 3 deletions twikit/group.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class Group:
The ID of the group.
name : :class:`str` | None
The name of the group.
members : :class:`list`[:class:`str`]
members : list[:class:`str`]
Member IDs
"""
def __init__(self, client: Client, group_id: str, data: dict) -> None:
Expand Down Expand Up @@ -52,7 +52,7 @@ def get_history(self, max_id: str | None = None) -> Result[GroupMessage]:
Returns
-------
:class:`Result`[:class:`GroupMessage`]
Result[:class:`GroupMessage`]
A Result object containing a list of GroupMessage objects
representing the DM conversation history.
Expand Down Expand Up @@ -81,7 +81,7 @@ def add_members(self, user_ids: list[str]) -> Response:
Parameters
----------
user_ids : :class:`list`[:class:`str`]
user_ids : list[:class:`str`]
List of IDs of users to be added.
Returns
Expand Down
6 changes: 3 additions & 3 deletions twikit/list.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def get_tweets(
Returns
-------
:class:`Result`[:class:`Tweet`]
Result[:class:`Tweet`]
A Result object containing the retrieved tweets.
Examples
Expand Down Expand Up @@ -195,7 +195,7 @@ def get_members(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
Members of the list
Examples
Expand Down Expand Up @@ -223,7 +223,7 @@ def get_subscribers(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
Subscribers of the list
Examples
Expand Down
2 changes: 1 addition & 1 deletion twikit/trend.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class Trend:
The count of tweets associated with the trend.
domain_context : :class:`str`
The context or domain associated with the trend.
grouped_trends : :class:`list`[:class:`str`]
grouped_trends : list[:class:`str`]
A list of trend names grouped under the main trend.
"""

Expand Down
16 changes: 8 additions & 8 deletions twikit/tweet.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ class Tweet:
The remaining number of edits allowed for the tweet.
state : :class:`str`
The state of the tweet views.
replies: :class:`Result`[:class:`Tweet`] | None
replies: Result[:class:`Tweet`] | None
Replies to the tweet.
reply_to: :class:`list`[:class:`Tweet`] | None
reply_to: list[:class:`Tweet`] | None
A list of Tweet objects representing the tweets to which to reply.
related_tweets : :class:`list`[:class:`Tweet`] | None
related_tweets : list[:class:`Tweet`] | None
Related tweets.
hashtags: :class:`list`[:class:`str`]
hashtags: list[:class:`str`]
Hashtags included in the tweet text.
poll : :class:`Poll`
Poll attached to the tweet.
Expand Down Expand Up @@ -295,7 +295,7 @@ def reply(
----------
text : :class:`str`, default=''
The text content of the reply.
media_ids : :class:`list`[:class:`str`], default=None
media_ids : list[:class:`str`], default=None
A list of media IDs or URIs to attach to the reply.
Media IDs can be obtained by using the `upload_media` method.
Expand Down Expand Up @@ -339,7 +339,7 @@ def get_retweeters(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of users who retweeted the tweet.
Examples
Expand Down Expand Up @@ -372,7 +372,7 @@ def get_favoriters(
Returns
-------
:class:`Result`[:class:`User`]
Result[:class:`User`]
A list of users who favorited the tweet.
Examples
Expand Down Expand Up @@ -439,7 +439,7 @@ class Poll:
The unique identifier of the poll.
name : :class:`str`
The name of the poll.
choices : :class:`list`[:class:`dict`]
choices : list[:class:`dict`]
A list containing dictionaries representing poll choices.
Each dictionary contains 'label' and 'count' keys
for choice label and count.
Expand Down
Loading

0 comments on commit 4469ac2

Please sign in to comment.