-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a4f8bbf
commit e1274ab
Showing
1 changed file
with
29 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| # PyTweetToolkit | ||
|
|
||
| <p align="center"> | ||
| <img src="./assets/logo.png" alt="Logo" height="128px"> | ||
| <img src="https://raw.githubusercontent.com/DavyJonesCodes/PyTweetToolkit/main/assets/logo.png" alt="Logo" height="128px"> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
|
|
@@ -10,84 +10,55 @@ | |
| <img src="https://img.shields.io/github/license/DavyJonesCodes/PyTweetToolkit?style=for-the-badge"/> | ||
| </p> | ||
|
|
||
| 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. | ||
| **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. | ||
|
|
||
| ## Features | ||
| ## ✨ Features | ||
|
|
||
| - **Tweet Posting**: Easily create and post tweets directly from your Python scripts. | ||
| - **User Engagement**: Automate following, unfollowing, blocking, and muting operations. | ||
| - **Analytics**: Analyze tweet performance, follower growth, and engagement metrics. | ||
| - **Content Automation**: Schedule tweets and manage your content strategy programmatically. | ||
| - 🐦 **Tweet Posting**: Easily create and post tweets directly from your Python scripts. | ||
| - 🤝 **User Engagement**: Automate following, unfollowing, blocking, and muting operations. | ||
| - 📊 **Analytics**: Analyze tweet performance, follower growth, and engagement metrics. | ||
| - 🗓️ **Content Automation**: Schedule tweets and manage your content strategy programmatically. | ||
|
|
||
| ## Installation | ||
| ## 🚀 Installation | ||
|
|
||
| PyTweetToolkit can be installed using multiple methods. Choose the one that suits your setup the best. | ||
|
|
||
| ### Install the latest version from PyPI | ||
|
|
||
| This is the easiest way to get PyTweetToolkit up and running. Use pip for installation: | ||
| You can easily install PyTweetToolkit via pip from [PyPI](https://pypi.org/project/PyTweetToolkit/): | ||
|
|
||
| ```bash | ||
| pip install PyTweetToolkit | ||
| ``` | ||
|
|
||
| For more details, visit [PyTweetToolkit on PyPI](https://pypi.org/project/PyTweetToolkit/). | ||
|
|
||
| ### Install the latest development version | ||
|
|
||
| If you prefer to use the bleeding-edge version, you can install directly from our GitHub repository. First, clone the repository: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/DavyJonesCodes/PyTweetToolkit.git | ||
| cd PyTweetToolkit | ||
| pip install . | ||
| ``` | ||
|
|
||
| Alternatively, you can install directly without cloning, using: | ||
| If you prefer to use the latest development version, you can install it directly from our GitHub repository: | ||
|
|
||
| ```bash | ||
| pip install git+https://github.com/DavyJonesCodes/PyTweetToolkit.git | ||
| ``` | ||
|
|
||
| ## Supported Python Versions | ||
| ## 🐍 Supported Python Versions | ||
|
|
||
| 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. | ||
|
|
||
| Make sure you have Python 3.9 or higher installed on your system to use PyTweetToolkit. You can check your Python version by running: | ||
| PyTweetToolkit is compatible with Python versions 3.9 and above. Make sure you have Python 3.9 or higher installed on your system: | ||
|
|
||
| ```bash | ||
| python --version | ||
| ``` | ||
|
|
||
| or, on some systems: | ||
|
|
||
| ```bash | ||
| python3 --version | ||
| ``` | ||
|
|
||
| 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. | ||
| If you need to install a newer version of Python, visit the [official Python website](https://www.python.org/downloads/) for installation instructions. | ||
|
|
||
| ## Obtaining Authentication Cookies | ||
| ## 🔐 Obtaining Authentication Cookies | ||
|
|
||
| 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: | ||
| To use PyTweetToolkit, you'll need to obtain authentication cookies from Twitter's website using your browser's developer tools. Follow these steps: | ||
|
|
||
| 1. **Login to Twitter**: Log in to your Twitter account in your web browser. | ||
| 2. **Open Developer Tools**: Right-click on the page and select "Inspect" to open the developer tools. | ||
| 3. **Navigate to Application Tab**: Go to the "Application" or "Storage" tab in the developer tools. | ||
| 4. **Find Twitter Cookies**: Look for the cookies associated with Twitter (`https://twitter.com`), especially `auth_token` and `ct0`. | ||
| 5. **Extract Cookie Values**: Copy the values of `auth_token` and `ct0`. | ||
| 6. **Use Cookie Values as Tokens**: Use these values as `auth_token` and `csrf_token` in your Python script. | ||
|
|
||
| 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". | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| 5. **Locating Cookie Values**: Locate the cookies associated with the Twitter website (`https://twitter.com`). Look for cookies named `auth_token` and `ct0`. | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| For detailed instructions on how to use PyTweetToolkit, refer to the [Quick Start](#quick-start) section below. | ||
| For detailed usage instructions, refer to the [Quick Start](#quick-start) section below. | ||
|
|
||
| ## Quick Start | ||
| ## ⚡ Quick Start | ||
|
|
||
| Here's a quick example to get you started with PyTweetToolkit: | ||
|
|
||
|
|
@@ -104,18 +75,18 @@ client.post_tweet("Hello, world! #MyFirstTweet") | |
| client.follow("python_community") | ||
| ``` | ||
|
|
||
| ## Documentation | ||
| ## 📚 Documentation | ||
|
|
||
| For detailed documentation, including setup guides, examples, and API references, please visit our [documentation page](https://github.com/DavyJonesCodes/PyTweetToolkit/wiki/1.-Home). | ||
|
|
||
| ## Contributing | ||
| ## 🤝 Contributions | ||
|
|
||
| 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. | ||
| 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]). | ||
|
|
||
| ## Support | ||
| ## 📄 License | ||
|
|
||
| If you encounter any issues or have questions about using PyTweetToolkit, please submit an issue on our GitHub issue tracker. | ||
| This project is licensed under the MIT License. For more details, see the [LICENSE](./LICENSE) file. | ||
|
|
||
| ## License | ||
| ## 📬 Support | ||
|
|
||
| PyTweetToolkit is released under the MIT License. | ||
| 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! 😊 | ||