Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
d60 authored Apr 8, 2024
1 parent 82f1689 commit aaaa4cf
Show file tree
Hide file tree
Showing 22 changed files with 1,067 additions and 1,066 deletions.
83 changes: 72 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,81 @@
<img src="https://i.imgur.com/iJe6rsZ.png" width="500">
<img src="https://i.imgur.com/iJe6rsZ.png" width="500">



![Number of GitHub stars](https://img.shields.io/github/stars/d60/twikit)

![GitHub commit activity](https://img.shields.io/github/commit-activity/m/d60/twikit)

![Version](https://img.shields.io/pypi/v/twikit?label=PyPI)

[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Create%20your%20own%20Twitter%20bot%20for%20free%20with%20%22Twikit%22!%20%23python%20%23twitter%20%23twikit%20%23programming%20%23github%20%23bot&url=https%3A%2F%2Fgithub.com%2Fd60%2Ftwikit)

[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/nCrByrr8cX)

[![BuyMeACoffee](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee)](https://www.buymeacoffee.com/d60py)


# Twikit <img height="35" src="https://i.imgur.com/9HSdIl4.png" valign="bottom">
# Twikit <img height="35" src="https://i.imgur.com/9HSdIl4.png" valign="bottom">

simple API wrapper to interact with twitter's unofficial API.

You can log in to Twitter using your account username, email address and password and use most features on Twitter, such as posting and retrieving tweets, liking and following users.

- [Documentation (English)](https://twikit.readthedocs.io/en/latest/twikit.html)

- [Async Documentation](https://twikit.readthedocs.io/en/latest/twikit.twikit_async.html)



If you have any questions, please ask on [Discord](https://discord.gg/nCrByrr8cX).



## Features

### No API Key Required
The library uses an unofficial API and therefore does **not require an API key**.

This library uses the unofficial API, therefore does **not require an API key**.

### Completely Free
The service is entirely free to use.

This library is completely free to use.

### Both Synchronous and Asynchronous Support

Whether you prefer **synchronous** or **asynchronous** programming,

Twikit supports both, providing flexibility for different use cases.


## Functionality

This library allows you to perform various Twitter-related actions, including:
- **Create tweets**
- **Search tweets**
- **Retrieve trending topics**

- **Create tweets**

- **Search tweets**

- **Retrieve trending topics**

- etc...



## Installing
```back
pip install twikit
```

```bash

pip install twikit

```



## Quick Example

**Define a client and log in to the account.**

```python
from twikit import Client

Expand All @@ -48,32 +85,56 @@ PASSWORD = 'password0000'

# Initialize client
client = Client('en-US')

# Login to the service with provided user credentials
client.login(
auth_info_1=USERNAME ,
auth_info_2=EMAIL,
password=PASSWORD
)
```

**Create a tweet with media attached.**

```python
# Upload media files and obtain media_ids
media_ids = [
client.upload_media('media1.jpg'),
client.upload_media('media2.jpg')
]

# Create a tweet with the provided text and attached media
client.create_tweet(
text='Example Tweet',
media_ids=media_ids
)

```

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

for tweet in tweets:
print(
tweet.user.name,
tweet.text,
tweet.created_at
)
```


More Examples: [examples](https://github.com/d60/twikit/tree/main/examples) <br>



## Contributing

I would like to hear your thoughts and suggestions.

If you have any features you'd like to see added or encounter any issues,

please let me know in the [issues](https://github.com/d60/twikit/issues) section.

Additionally, if you find this library useful, I would appreciate it if you would star this repository or share this library⭐! Thank you very much!

Additionally, if you find this library useful, I would appreciate it if you would star this repository or share this library⭐! Thank you very much!
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
'fake_useragent',
'filetype'
],
python_requires='>=3.9',
python_requires='>=3.10',
description='Twitter API wrapper for python with **no API key required**.',
long_description=long_description,
long_description_content_type='text/markdown',
Expand Down
15 changes: 3 additions & 12 deletions twikit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,11 @@
from .client import Client
from .group import Group, GroupMessage
from .list import List
from .errors import (
BadRequest,
Forbidden,
NotFound,
RequestTimeout,
ServerError,
TooManyRequests,
TwitterException,
Unauthorized
)
from .errors import *
from .message import Message
from .trend import Trend
from .tweet import ScheduledTweet, Tweet
from .tweet import Poll, ScheduledTweet, Tweet
from .user import User
from .utils import build_query

__version__ = '1.4.4'
__version__ = '1.4.5'
Loading

0 comments on commit aaaa4cf

Please sign in to comment.