pyguitest 0.1.0__tar.gz

pyguitest-0.1.0/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to pyguitest are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
+[semantic versioning](https://semver.org/spec/v2.0.0.html) — with the usual
+0.x caveat that the API may still change between minor versions.
+
+## [Unreleased]
+
+## [0.1.0] — 2026-08-29
+
+First public release.
+
+### Added
+
+- Capability negotiation as public API: `connect()`, `supports()`,
+  `Capability`, `CapabilitySet` and the T1–T6 tier scale from the
+  X11::GUITest audit in `docs/wayland-audit.html`.
+- Element automation over AT-SPI, the one layer that behaves identically
+  under X11 and Wayland.
+- Input injection backends: X11, XDG desktop portal (RemoteDesktop),
+  GNOME Shell extension, libei (opt-in), uinput, and the `wdotool`/`wtype`
+  command-line tools.
+- Screen capture and image search: portal capture, `grim`, X11, and
+  template matching through ImageMagick.
+- Window management per compositor, including the GNOME Shell extension
+  path, since Mutter implements no foreign-toplevel protocol.
+- A `pyguitest` command-line entry point.
+- PEP 561 type information (`py.typed`); no hard runtime dependencies.
+
+[Unreleased]: https://github.com/ctrondlp/pyguitest/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ctrondlp/pyguitest/tree/v0.1.0

pyguitest-0.1.0/LICENSE

@@ -0,0 +1,354 @@
+pyguitest
+Copyright (C) 2026  Dennis K. Paulsen
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, see <https://www.gnu.org/licenses/>.
+
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Moe Ghoul>, 1 April 1989
+  Moe Ghoul, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

pyguitest-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+# The sdist picks up README, LICENSE, pyproject.toml and tests/ on its own.
+# These are the ones setuptools does not infer, and they matter: distro
+# packagers build from the sdist and expect the changelog and the docs that
+# the README and the source comments point at.
+include CHANGELOG.md
+recursive-include docs *
+recursive-include examples *
+recursive-include scripts *
+prune docs/__pycache__
+global-exclude *.py[cod] __pycache__/*

pyguitest-0.1.0/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: pyguitest
+Version: 0.1.0
+Summary: Cross-platform GUI automation; successor to X11::GUITest
+Author: Dennis K. Paulsen
+License-Expression: GPL-2.0-or-later
+Project-URL: homepage, https://github.com/ctrondlp/pyguitest
+Project-URL: repository, https://github.com/ctrondlp/pyguitest
+Project-URL: issues, https://github.com/ctrondlp/pyguitest/issues
+Project-URL: documentation, https://github.com/ctrondlp/pyguitest/tree/main/docs
+Project-URL: changelog, https://github.com/ctrondlp/pyguitest/blob/main/CHANGELOG.md
+Keywords: gui-automation,testing,x11,wayland,accessibility,atspi
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: POSIX :: BSD :: FreeBSD
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Environment :: X11 Applications
+Classifier: Topic :: Desktop Environment
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: atspi
+Requires-Dist: dogtail>=2.0; extra == "atspi"
+Provides-Extra: x11
+Requires-Dist: python-xlib>=0.33; extra == "x11"
+Provides-Extra: uinput
+Requires-Dist: evdev>=1.9; extra == "uinput"
+Provides-Extra: eiinput
+Requires-Dist: python-libei>=0.1.0; extra == "eiinput"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Requires-Dist: python-dbusmock>=0.30; extra == "dev"
+Dynamic: license-file
+
+# pyguitest
+
+Cross-platform GUI automation for Python. Successor to
+[X11::GUITest](https://metacpan.org/pod/X11::GUITest).
+
+**Status:** every capability implemented across all backends, covering
+**every X11::GUITest export**. Much of it has been run against real GNOME
+Wayland and X11 sessions; some of it has not, and
+[docs/validation.md](docs/validation.md) says exactly which is which, so
+nothing here has to be taken on trust.
+
+## Why the API is not a port
+
+`docs/wayland-audit.html` classifies all 50 X11::GUITest 0.29 exports by what it
+would cost to implement each on Wayland. The distribution is the finding:
+
+| Tier | Count | Meaning |
+|------|-------|---------|
+| T1 Portable   | 9  | No display server involved; ports unchanged |
+| T2 Direct     | 4  | Core Wayland protocol gives a real equivalent |
+| T3 Compositor | 19 | Needs a separate backend per desktop |
+| T4 Privileged | 8  | Input injection; consent or device access |
+| T5 Rework     | 4  | Goal survives via AT-SPI; the model does not |
+| T6 No path    | 6  | Deliberately prevented; dropped from the API |
+
+Thirteen of fifty carry over unchanged. The largest block is not "impossible"
+but "possible once per desktop" — window management is where a portable Wayland
+implementation actually fails, and GNOME is the worst case because Mutter
+implements neither foreign-toplevel protocol.
+
+The tier scale is a *Wayland ceiling*, not an absolute one. On Wayland every
+achievable capability is served and the tier-6 ones cannot exist; the X11
+backend serves those too, so an X11 session gets a strictly larger capability
+set through the same API. Discovering which one you are on is what
+`supports()` is for.
+
+## Design decisions that follow
+
+- **Capability negotiation is public API.** With 19 functions varying by
+  compositor, X11::GUITest's convention of returning zero on failure is
+  untestable — it cannot distinguish "the click missed" from "this desktop
+  cannot click". Every failure here is a typed exception, and callers can ask
+  first.
+- **Speak protocols directly; adapt tools only where no protocol exists.** sway,
+  Hyprland and niri window control talks to their unix sockets using nothing but
+  the stdlib, so no tool need be installed. dogtail covers elements, python-xlib
+  covers X11, python-evdev covers in-process uinput; `kdotool` and the
+  screenshot tools stay CLI adapters because they wrap genuinely hard work.
+  See [ADR 001](docs/adr-001-dependencies.md) and
+  [ADR 002](docs/adr-002-transports.md).
+- **Input tools are ranked by keymap safety.** `wdotool` and `wtype` let the
+  client supply a keymap; `ydotool` injects scancodes *below* the compositor, so
+  `type_text("Hello")` produces different characters on an AZERTY session and no
+  protocol reports the active layout. That ranking is encoded in `tools.py`, and
+  detection warns when only keymap-unsafe tools are present.
+- **AT-SPI leads.** It answers what the window-tree walk was really used for,
+  needs neither geometry nor injection permission, and behaves identically under
+  X11 and Wayland — the one layer needing no backend matrix.
+- **The X11 backend is a peer, not a legacy path.** It is the surest route to
+  the BSDs and Solaris — python-xlib speaks the wire protocol in pure Python and
+  assumes no kernel — and the only backend serving tier-6 capabilities at all.
+  Less is Linux-only than it looks: `/dev/uinput` and libei are kernel
+  interfaces, but compositor IPC is a unix socket and JSON, and sway, grim and
+  wtype are all in FreeBSD ports. Nothing here gates on the platform; nothing
+  off Linux is tested either.
+- **Compositor IPC fills the geometry hole.** sway, Hyprland and niri report
+  window rectangles, which no Wayland protocol exposes — and once every rectangle is
+  known, hit-testing a coordinate is arithmetic rather than a compositor query.
+- **No hard dependencies.** Every mechanism is probed at runtime and degrades to
+  an unsupported capability rather than an import error. Extras are per-backend,
+  so a real install is the package plus one extra.
+
+## Install
+
+Requires Python 3.10 or newer. Not published yet —
+`pyproject.toml` carries the `Private :: Do Not Upload` classifier, which
+PyPI rejects — so for now installation is from a checkout:
+
+```sh
+git clone https://github.com/ctrondlp/pyguitest.git
+cd pyguitest
+pip install .                # core; no dependencies
+pip install '.[atspi]'       # + element automation
+```
+
+Once published, that becomes `pip install pyguitest` and
+`pip install 'pyguitest[atspi]'`. You do not need `-e`; that flag is for
+developing *this package*, and is covered in
+[CONTRIBUTING.md](CONTRIBUTING.md).
+
+**None are required.** The package imports and runs with nothing else
+installed. What you add depends on which backend has to serve your desktop
+— extras (`atspi`, `x11`, `uinput`, `eiinput`, `dev`), a few distribution
+packages pip cannot supply, and sometimes a tool on `PATH`. Rather than work
+that out from a document, ask the machine:
+
+```sh
+pyguitest doctor
+```
+
+It detects your distribution and prints the exact commands. For the whole
+picture — a per-backend requirements matrix, the distribution package table,
+and how capture chooses a path — see [docs/install.md](docs/install.md).
+Injecting input has its own setup (`/dev/uinput` permissions, the `ydotool`
+daemon, libei, portal consent): [docs/input.md](docs/input.md).
+
+## Usage
+
+```python
+import pyguitest
+
+gui = pyguitest.connect()
+
+# Widgets by what they are and what they are called -- the recommended way.
+gui.button("OK").click()
+gui.text_field("Name").set_text("Ada Lovelace")
+gui.dropdown("Country").choose("Norway")
+
+# Windows by title regex.
+window = gui.find_window("Editor")
+
+# Coordinates and keys, when you need them.
+gui.move_mouse(500, 300)
+gui.click()
+gui.type_text("Hello")
+gui.send_keys("^(a)^(c)")  # Ctrl-A, Ctrl-C
+```
+
+Matching on role and name survives the application being moved or resized,
+unlike clicking at `(842, 612)`. Ask before depending on anything that varies
+by desktop:
+
+```python
+from pyguitest import Capability
+
+if gui.supports(Capability.WINDOW_GEOMETRY):
+    x, y, w, h = gui.geometry(window)
+```
+
+`connect()` never raises on a limited desktop — a session with few capabilities
+is the normal case, and `supports()` is how you find out.
+
+A session is usually several backends at once: elements from AT-SPI, injection
+from a CLI adapter, capture from another. `CompositeBackend` merges their
+capabilities and routes each call to whichever member provides it, so callers
+see one object. `backend.providers()` shows the routing.
+
+### Screenshots
+
+```python
+gui.screenshot("desktop.png")                       # the whole desktop
+gui.screenshot("editor.png", window=window)         # one window
+gui.screenshot("corner.png", region=(0, 0, 400, 300))
+```
+
+`region` is `(x, y, width, height)` in screen coordinates — the same tuple
+`gui.geometry(window)` returns, on every backend. You never write a tool's
+own rectangle syntax; whichever tool the session picked gets its own built
+for it. `window` is served two ways, and the difference shows in the image:
+under X11 the window's own pixels are read, so anything stacked on top of it
+is absent; everywhere else the rectangle is looked up and cut out of a
+full-screen shot, which does include whatever is covering it.
+`gui.supports(Capability.WINDOW_CAPTURE)` tells you which you are getting.
+
+**Automatically, when a test fails.** Nothing captures on its own — a
+screenshot has to be taken while the failure is still propagating, because
+by the time an `except:` block runs the application under test is usually
+gone. Wrap the part you want documented:
+
+```python
+with gui.capture_on_failure("artifacts"):
+    gui.button("Save").click()
+    assert gui.element(name="Saved")
+```
+
+Nothing is written when the block succeeds. On failure the image lands in
+`artifacts/` (or `$PYGUITEST_SCREENSHOT_DIR`, or the temporary directory),
+its path is attached to the exception as `.screenshot`, and the original
+exception is re-raised untouched, so the test runner still reports the real
+failure. A screenshot that itself fails is recorded on the exception as
+`.screenshot_error` and swallowed — it never replaces the failure it was
+trying to document.
+
+## Examples
+
+Runnable scripts in [examples/](examples/), each degrading with an
+explanation when the desktop cannot do what it asks:
+
+```sh
+python3 examples/01_what_can_i_do.py     # start here
+python3 examples/03_widgets.py           # buttons, text boxes, dropdowns
+python3 examples/06_a_real_test.py       # the one to copy: a unittest suite
+```
+
+## Tools
+
+```sh
+pyguitest                     # what this desktop can actually do
+pyguitest doctor              # what to install to unlock more
+pyguitest debug               # everything needed to diagnose a bug report
+pyguitest migrate script.pl   # what porting a Perl script involves
+```
+
+All four also work as `python -m pyguitest …` without installing.
+
+`pyguitest debug` is what to paste into a bug report: package and Python
+versions, every environment probe (not only the ones that came back true),
+each detected tool's own `--version`, and whether the process is running
+inside a Flatpak, toolbox, or other container -- which changes what every
+other probe on this list actually sees. Add `--json` for a machine-readable
+form.
+
+The migration scanner reports the tier of every X11::GUITest call in a source
+file and exits non-zero if any call has no Wayland path, so a port can be gated
+in CI.
+
+## Documentation
+
+- [docs/install.md](docs/install.md) — what each backend needs, per
+  distribution, and how capture picks a path
+- [docs/input.md](docs/input.md) — injecting pointer and keyboard input:
+  permissions, daemons, keymap safety, libei and the portal
+- [docs/validation.md](docs/validation.md) — what has been run against a real
+  desktop, and what has not
+- [docs/structure.md](docs/structure.md) — the file tree, how a call flows
+  through the layers, and the backend registry
+- [ADR 001](docs/adr-001-dependencies.md) — why these libraries
+- [ADR 002](docs/adr-002-transports.md) — why sockets replaced CLI tools
+- [docs/wayland-audit.html](docs/wayland-audit.html) — the audit all of this
+  derives from
+
+## Contributing
+
+Tests, lint, types, CI and the D-Bus suite: [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+GPL-2.0-or-later. See [LICENSE](LICENSE).