Skip to content

Update README to match the code - #60

Merged
nicoddemus merged 1 commit into
pytest-dev:mainfrom
nicoddemus:readme-fixes
Nov 18, 2026
Merged

nicoddemus merged 1 commit into
pytest-dev:mainfrom
nicoddemus:readme-fixes

Conversation

@nicoddemus

@nicoddemus nicoddemus commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

Reviewed the README against the code and fixed what had drifted:

Incorrect descriptions

  • memory_root_dir: defaults to /dev/shm (not /var/shm), only when it has enough free space, falling back to root_dir.
  • memory_temp_dir is a subfolder of memory_base_dir, not base_dir; run_dir is a subfolder of memory_temp_dir, not memory_root_dir.
  • lock_resource_timeout: clarify it is the max seconds to wait for a resource lock (default 20).
  • Memcached: the extra is memcached (not memcache), and only memcached_client/memcached_clean need pylibmc.
  • MySQL example: connect via unix_socket=mysql_socket (the server runs with --skip-networking) and note it needs mysqlclient.

Missing documentation

  • New Requirements section listing the system programs needed (memcached, mysqld & friends, Xvfb) and that services are POSIX-only.
  • Document memcached_clean, the mysql_* helper fixtures and clean_django_settings.

django_settings warning

  • Added a warning that pytest_services.django_settings is incompatible with current Python/Django (imp was removed in Python 3.12, django.core.urlresolvers in Django 2.0). The code itself still needs fixing or removing; that's left for a follow-up.

Housekeeping

  • Replace the dead Travis CI and Coveralls badges with the GitHub Actions test badge; pypi.python.org → pypi.org, http → https, master → main.
  • Use double backticks for inline literals (single backticks render as italics in reST) and fix typos.

Validated with docutils (no warnings) and readme_renderer (PyPI rendering).

🤖 Generated with Claude Code


This change is Reviewable

- Fix fixture descriptions that disagreed with the code (memory_root_dir,
  memory_temp_dir, run_dir, lock_resource_timeout, memcached extra name).
- Document missing fixtures (memcached_clean, mysql_* helpers) and
  clean_django_settings.
- Add a Requirements section listing the needed system programs.
- Fix the MySQL example to connect through the unix socket.
- Warn that django_settings is incompatible with current Python/Django.
- Replace the dead Travis/Coveralls badges with the GitHub Actions badge,
  update PyPI/http links and master -> main.
- Use double backticks for inline literals and fix typos.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@nicoddemus
nicoddemus merged commit 2346c6c into pytest-dev:main Nov 18, 2026
6 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