Skip to content

Commit e1274ab

Browse files
Update README.md
1 parent a4f8bbf commit e1274ab

File tree

1 file changed

+29
-58
lines changed

1 file changed

+29
-58
lines changed

README.md

Lines changed: 29 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PyTweetToolkit
22

33
<p align="center">
4-
<img src="./assets/logo.png" alt="Logo" height="128px">
4+
<img src="https://raw.githubusercontent.com/DavyJonesCodes/PyTweetToolkit/main/assets/logo.png" alt="Logo" height="128px">
55
</p>
66

77
<p align="center">
@@ -10,84 +10,55 @@
1010
<img src="https://img.shields.io/github/license/DavyJonesCodes/PyTweetToolkit?style=for-the-badge"/>
1111
</p>
1212

13-
PyTweetToolkit is an intuitive Python library designed to simplify Twitter interactions, offering tools for posting tweets, engaging with followers, analyzing social media metrics, and automating various Twitter-related tasks. Ideal for developers looking to integrate Twitter functionality into Python projects or automate their social media presence with ease.
13+
**PyTweetToolkit** is an intuitive Python library designed to simplify Twitter interactions, offering tools for posting tweets, engaging with followers, analyzing social media metrics, and automating various Twitter-related tasks. It's perfect for developers looking to integrate Twitter functionality into Python projects or automate their social media presence with ease.
1414

15-
## Features
15+
## Features
1616

17-
- **Tweet Posting**: Easily create and post tweets directly from your Python scripts.
18-
- **User Engagement**: Automate following, unfollowing, blocking, and muting operations.
19-
- **Analytics**: Analyze tweet performance, follower growth, and engagement metrics.
20-
- **Content Automation**: Schedule tweets and manage your content strategy programmatically.
17+
- 🐦 **Tweet Posting**: Easily create and post tweets directly from your Python scripts.
18+
- 🤝 **User Engagement**: Automate following, unfollowing, blocking, and muting operations.
19+
- 📊 **Analytics**: Analyze tweet performance, follower growth, and engagement metrics.
20+
- 🗓️ **Content Automation**: Schedule tweets and manage your content strategy programmatically.
2121

22-
## Installation
22+
## 🚀 Installation
2323

24-
PyTweetToolkit can be installed using multiple methods. Choose the one that suits your setup the best.
25-
26-
### Install the latest version from PyPI
27-
28-
This is the easiest way to get PyTweetToolkit up and running. Use pip for installation:
24+
You can easily install PyTweetToolkit via pip from [PyPI](https://pypi.org/project/PyTweetToolkit/):
2925

3026
```bash
3127
pip install PyTweetToolkit
3228
```
3329

34-
For more details, visit [PyTweetToolkit on PyPI](https://pypi.org/project/PyTweetToolkit/).
35-
3630
### Install the latest development version
3731

38-
If you prefer to use the bleeding-edge version, you can install directly from our GitHub repository. First, clone the repository:
39-
40-
```bash
41-
git clone https://github.com/DavyJonesCodes/PyTweetToolkit.git
42-
cd PyTweetToolkit
43-
pip install .
44-
```
45-
46-
Alternatively, you can install directly without cloning, using:
32+
If you prefer to use the latest development version, you can install it directly from our GitHub repository:
4733

4834
```bash
4935
pip install git+https://github.com/DavyJonesCodes/PyTweetToolkit.git
5036
```
5137

52-
## Supported Python Versions
38+
## 🐍 Supported Python Versions
5339

54-
PyTweetToolkit is compatible with Python versions 3.9 and above. This ensures the use of the latest features and improvements in the Python language, providing a better and more efficient experience for developers using PyTweetToolkit.
55-
56-
Make sure you have Python 3.9 or higher installed on your system to use PyTweetToolkit. You can check your Python version by running:
40+
PyTweetToolkit is compatible with Python versions 3.9 and above. Make sure you have Python 3.9 or higher installed on your system:
5741

5842
```bash
5943
python --version
6044
```
6145

62-
or, on some systems:
63-
64-
```bash
65-
python3 --version
66-
```
67-
68-
If you need to install a newer version of Python, visit the [official Python website](https://www.python.org/downloads/) for download links and installation instructions.
46+
If you need to install a newer version of Python, visit the [official Python website](https://www.python.org/downloads/) for installation instructions.
6947

70-
## Obtaining Authentication Cookies
48+
## 🔐 Obtaining Authentication Cookies
7149

72-
To use PyTweetToolkit, you'll need to obtain authentication cookies from Twitter's website using your browser's developer tools. Follow these steps to retrieve the required cookies:
50+
To use PyTweetToolkit, you'll need to obtain authentication cookies from Twitter's website using your browser's developer tools. Follow these steps:
7351

7452
1. **Login to Twitter**: Log in to your Twitter account in your web browser.
53+
2. **Open Developer Tools**: Right-click on the page and select "Inspect" to open the developer tools.
54+
3. **Navigate to Application Tab**: Go to the "Application" or "Storage" tab in the developer tools.
55+
4. **Find Twitter Cookies**: Look for the cookies associated with Twitter (`https://twitter.com`), especially `auth_token` and `ct0`.
56+
5. **Extract Cookie Values**: Copy the values of `auth_token` and `ct0`.
57+
6. **Use Cookie Values as Tokens**: Use these values as `auth_token` and `csrf_token` in your Python script.
7558

76-
2. **Open Developer Tools**: Once logged in, open the developer tools in your web browser. You can usually access this by right-clicking on the page and selecting "Inspect".
77-
78-
3. **Navigate to Application Tab**: In the developer tools, navigate to the "Application" or "Storage" tab. This tab contains information about cookies, local storage, and session storage.
79-
80-
4. **Find Twitter Cookies**: Look for the section that displays cookies. Find the cookies associated with the Twitter website (`https://twitter.com`). These cookies typically include `auth_token` and `ct0`, among others.
81-
82-
5. **Locating Cookie Values**: Locate the cookies associated with the Twitter website (`https://twitter.com`). Look for cookies named `auth_token` and `ct0`.
83-
84-
6. **Extract Cookie Values**: Double-click on the value of the `auth_token` cookie to copy it. Similarly, double-click on the value of the `ct0` cookie to copy it as well.
85-
86-
7. **Use Cookie Values as Tokens**: In your Python script or application, replace `YOUR_AUTH_TOKEN` with the value copied from the `auth_token` cookie and `YOUR_CSRF_TOKEN` with the value copied from the `ct0` cookie. These values will serve as your authentication token (`auth_token`) and Cross-Site Request Forgery (CSRF) token (`csrf_token`), respectively.
87-
88-
For detailed instructions on how to use PyTweetToolkit, refer to the [Quick Start](#quick-start) section below.
59+
For detailed usage instructions, refer to the [Quick Start](#quick-start) section below.
8960

90-
## Quick Start
61+
## Quick Start
9162

9263
Here's a quick example to get you started with PyTweetToolkit:
9364

@@ -104,18 +75,18 @@ client.post_tweet("Hello, world! #MyFirstTweet")
10475
client.follow("python_community")
10576
```
10677

107-
## Documentation
78+
## 📚 Documentation
10879

10980
For detailed documentation, including setup guides, examples, and API references, please visit our [documentation page](https://github.com/DavyJonesCodes/PyTweetToolkit/wiki/1.-Home).
11081

111-
## Contributing
82+
## 🤝 Contributions
11283

113-
We welcome contributions to PyTweetToolkit! If you'd like to contribute, please fork the repository and use a pull request to add your changes. For more detailed information, check out our CONTRIBUTING.md.
84+
Contributions are welcome! 🎉 If you'd like to contribute to PyTweetToolkit, feel free to fork the repository and submit a pull request. If you have any questions or need guidance, don't hesitate to contact me at [[email protected]](mailto:[email protected]).
11485

115-
## Support
86+
## 📄 License
11687

117-
If you encounter any issues or have questions about using PyTweetToolkit, please submit an issue on our GitHub issue tracker.
88+
This project is licensed under the MIT License. For more details, see the [LICENSE](./LICENSE) file.
11889

119-
## License
90+
## 📬 Support
12091

121-
PyTweetToolkit is released under the MIT License.
92+
If you have any questions, suggestions, or run into any issues, feel free to open an issue on our GitHub repository or reach out via email at [[email protected]](mailto:[email protected]). We're here to help! 😊

0 commit comments

Comments
 (0)