Skip to content

docs: improve README and PyPI metadata for discoverability - #7

Merged
godhiraj-code merged 1 commit into
mainfrom
docs/ai-visibility
Oct 18, 2026
Merged

godhiraj-code merged 1 commit into
mainfrom
docs/ai-visibility

Conversation

@godhiraj-code

Copy link
Copy Markdown
Owner

Changes

  • README: problem-first opening that names the real errors (StaleElementReferenceException, ElementClickInterceptedException, NoSuchElementException, time.sleep). It notes that animation and layout waits only apply in strict mode, to match the code.
  • README: PyPI version, Python versions and license badges next to the existing CI badge. Added a "Learn more" line linking both blog posts and the project page (all checked, all return 200).
  • README: added an implicitly_wait row to the comparison table. New "When to use Waitless (and when not to)" section: Playwright, specific business conditions, a comparison table.
  • README: new FAQ/troubleshooting section (pytest fixture, open Shadow DOM, SeleniumBase/wrappers, apps that never go idle, overhead, isinstance). Changed the CHANGELOG and LICENSE links to absolute URLs so they work on PyPI.
  • pyproject: new one-line summary. More keywords and classifiers (all checked against trove-classifiers). Homepage now points to https://www.dhirajdas.dev/project/waitless. Added a Blog URL. Repository no longer ends in .git. Build requirement is now setuptools>=77, which the SPDX license = "MIT" string needs.
  • Version: bumped to 1.0.5 in pyproject.toml, waitless/__init__.py and the instrumentation version string. CHANGELOG has an Unreleased entry. The new summary, keywords and README only show up on PyPI after a release. No behavior changes.

Checks

  • python -m build + twine check --strict dist/*: PASSED (wheel and sdist)
  • pytest tests/unit: 167 passed

Repo settings changed directly (already live)

  • Added topics: selenium-python, webdriver, pytest, auto-wait, test-automation. Description and homepage were already set and are unchanged.

After merging

  • Publish 1.0.5 to PyPI by running the "Publish to PyPI" workflow (workflow_dispatch).

@godhiraj-code
godhiraj-code merged commit 1deb555 into main Oct 18, 2026
8 checks passed
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.

1 participant