Skip to content

Update Python package installation instructions #2235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 25, 2025

Conversation

cgoldberg
Copy link
Contributor

@cgoldberg cgoldberg commented Mar 22, 2025

User description

Description

This PR updates the installation instructions for the Python selenium package.

Previously, it showed how to download and install the source archive from PyPI. Installing from the source archive no longer works without a significant toolchain installed. I replaced the instructions with instructions for installing from the built distribution (wheel package), which essentially does the same thing. I also changed the instructions to use pip install instead of setup.py install since the latter no longer works in Python.

I made this change in all translated languages.

Motivation and Context

Updating installation instructions that no longer work to new working instructions.

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

Documentation, Enhancement


Description

  • Updated Python Selenium installation instructions across multiple languages.
    • Replaced setup.py install with pip install.
    • Switched from source archive to built distribution (wheel).

Changes walkthrough 📝

Relevant files
Enhancement
+1/-1     
Documentation
install_library.en.md
Update English installation instructions for Selenium       

website_and_docs/content/documentation/webdriver/getting_started/install_library.en.md

  • Updated installation instructions to use pip install.
  • Replaced source archive with built distribution (wheel).
  • Minor punctuation correction in text.
  • +4/-4     
    install_library.ja.md
    Update Japanese installation instructions for Selenium     

    website_and_docs/content/documentation/webdriver/getting_started/install_library.ja.md

  • Updated installation instructions to use pip install.
  • Replaced source archive with built distribution (wheel).
  • +2/-2     
    install_library.pt-br.md
    Update Brazilian Portuguese installation instructions for Selenium

    website_and_docs/content/documentation/webdriver/getting_started/install_library.pt-br.md

  • Updated installation instructions to use pip install.
  • Replaced source archive with built distribution (wheel).
  • Minor punctuation correction in text.
  • +3/-3     
    install_library.zh-cn.md
    Update Simplified Chinese installation instructions for Selenium

    website_and_docs/content/documentation/webdriver/getting_started/install_library.zh-cn.md

  • Updated installation instructions to use pip install.
  • Replaced source archive with built distribution (wheel).
  • +3/-3     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copy link

    netlify bot commented Mar 22, 2025

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 3b3a849

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Translation Inconsistency

    The link text was changed from "PyPI source archive" to "PyPI Built Distribution" in English, but the Chinese version uses English text instead of a translated term. Consider translating this term to maintain consistency.

    此外你可以从这里下载 [PyPI Built Distribution](https://pypi.org/project/selenium/#files)
    Translation Mismatch

    The link text was updated to "PyPI Built Distribution" in English, but the Portuguese version still refers to "código fonte PyPI" (PyPI source code) which doesn't match the new wheel package context.

    Como uma alternativa você pode baixar o [código fonte PyPI](https://pypi.org/project/selenium/#files)
    (selenium-x.x.x.-py3-none-any.whl) e instalar usando _pip_:

    Copy link
    Contributor

    qodo-merge-pro bot commented Mar 22, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Fix inconsistent terminology

    The text still refers to "PyPI ソースアーカイブ" (source archive) in Japanese, but the
    file type has been updated to a wheel file. Update the text to refer to "PyPI
    Built Distribution" in Japanese to match the file type change.

    website_and_docs/content/documentation/webdriver/getting_started/install_library.ja.md [50-51]

    -または、ダウンロードすることもできます[PyPI ソースアーカイブ](https://pypi.org/project/selenium/#files)
    +または、ダウンロードすることもできます[PyPI ビルド配布](https://pypi.org/project/selenium/#files)
     (selenium-x.x.x.-py3-none-any.whl) を使用してインストールします _pip_:
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    __

    Why: The suggestion correctly identifies a terminology inconsistency where the Japanese text still refers to "source archive" while the file type has been updated to a wheel file. This improves documentation accuracy and prevents user confusion.

    Medium
    Fix missing punctuation
    Suggestion Impact:The suggestion was directly implemented in the commit. The period was added at the end of the sentence as suggested.

    code diff:

    -em "Supported Python Versions" no [PyPi](https://pypi.org/project/selenium/)
    +em "Supported Python Versions" no [PyPi](https://pypi.org/project/selenium/).

    Add a period at the end of the sentence to maintain consistency with the English
    version, which has the period added.

    website_and_docs/content/documentation/webdriver/getting_started/install_library.pt-br.md [40]

    -em "Supported Python Versions" no [PyPi](https://pypi.org/project/selenium/)
    +em "Supported Python Versions" no [PyPi](https://pypi.org/project/selenium/).

    [Suggestion has been applied]

    Suggestion importance[1-10]: 2

    __

    Why: The suggestion correctly identifies a missing period at the end of the sentence in the Portuguese version, which would make it consistent with the English version. However, this is a very minor punctuation fix with minimal impact on functionality or understanding.

    Low
    • Update

    @cgoldberg
    Copy link
    Contributor Author

    Any idea why tests are failing? Was it the version bump?

    @cgoldberg
    Copy link
    Contributor Author

    I bumped the Python version back to 4.29.0 to see if tests will pass again.

    @cgoldberg
    Copy link
    Contributor Author

    @harsha509 can someone review this?

    Copy link
    Member

    @harsha509 harsha509 left a comment

    Choose a reason for hiding this comment

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

    Thank you @cgoldberg !

    @harsha509 harsha509 merged commit a6bd46e into SeleniumHQ:trunk Mar 25, 2025
    3 checks passed
    selenium-ci added a commit that referenced this pull request Mar 25, 2025
    * Update Python package installation instructions
    
    * Update Python package installation instructions translations
    
    * Add punctuation
    
    * Bumped python version back to 4.29.0 a6bd46e
    @cgoldberg cgoldberg deleted the py-docs-install branch April 23, 2025 04:20
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants