Skip to content

Update README with latest API changes and deprecation warnings#4

Merged
lumensparkxy merged 3 commits intomainfrom
copilot/fix-3
May 31, 2025
Merged

Update README with latest API changes and deprecation warnings#4
lumensparkxy merged 3 commits intomainfrom
copilot/fix-3

Conversation

Copy link
Contributor

Copilot AI commented May 31, 2025

This PR comprehensively updates the README.md file to reflect the latest changes in dependencies and APIs, addressing outdated information and providing users with current best practices.

Key Updates Made

1. Added Important Deprecation Warnings

  • Clear notice at the top about deprecated APIs and libraries
  • Links to detailed Known Issues section for solutions

2. Updated Requirements and Dependencies

  • Bumped Python version recommendation from 3.7+ to 3.8+
  • Added detailed descriptions for each dependency
  • Included modern alternatives with installation commands
  • Updated requirements.txt with inline deprecation warnings

3. Comprehensive Known Issues Section

  • OpenAI API: Documented transition from deprecated openai.ChatCompletion.create() to modern client-based API
  • Selenium WebDriver: Documented transition from deprecated find_element_by_*() methods to modern By locators
  • Twitter API: Noted library deprecation and recommended tweepy as modern alternative
  • Hardcoded Paths: Listed specific files and line numbers that need updating
  • ChromeDriver Management: Suggested webdriver-manager for automatic driver management

4. Enhanced Setup and Usage Instructions

  • Added environment variable setup examples
  • Improved command-line usage examples for each script
  • Added Jupyter notebook usage guidance
  • Emphasized critical setup requirements

5. New Troubleshooting Section

  • Version compatibility guidance for OpenAI API
  • Modern Selenium installation instructions
  • Notes about current Twitter/X API requirements

Files Changed

  • README.md: Complete modernization with deprecation warnings and current best practices
  • requirements.txt: Added inline comments warning about deprecated libraries

Before vs After

Before: Users would encounter runtime errors due to deprecated APIs without clear guidance
After: Users receive clear warnings about deprecated code and specific instructions for modern alternatives

This update ensures users can successfully run existing scripts while being informed about better, more maintainable approaches for new development.

Fixes #3.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits May 31, 2025 20:29
…arnings

Co-authored-by: lumensparkxy <12463711+lumensparkxy@users.noreply.github.com>
Co-authored-by: lumensparkxy <12463711+lumensparkxy@users.noreply.github.com>
Copilot AI changed the title [WIP] Update readme Update README with latest API changes and deprecation warnings May 31, 2025
Copilot AI requested a review from lumensparkxy May 31, 2025 20:31
Copy link
Owner

@lumensparkxy lumensparkxy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the code so that deprecated functions can be removed and alienate functions can be used

Try to use python LTE

@lumensparkxy lumensparkxy marked this pull request as ready for review May 31, 2025 20:39
@lumensparkxy lumensparkxy merged commit 93668bf into main May 31, 2025
1 check passed
@lumensparkxy lumensparkxy deleted the copilot/fix-3 branch May 31, 2025 20:40
Copy link
Contributor Author

Copilot AI commented May 31, 2025

Update the code so that deprecated functions can be removed and alienate functions can be used

Try to use python LTE

I've updated the code to remove deprecated functions and use modern alternatives:

OpenAI script: Updated to use OpenAI v1.0+ client-based API and replaced twitter library with tweepy
Selenium script: Updated to use modern By locators and automatic ChromeDriver management with webdriver-manager
Requirements: Updated to specify modern library versions (OpenAI >=1.0.0, tweepy >=4.0.0, selenium >=4.0.0)
README: Removed deprecation warnings since code now uses current best practices

Changes committed in a0a8c0f

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update readme

2 participants