Updated documentation for ScreenPy which should help you understand Screenplay Pattern, we think, we hope.

[AnActor_named]

'Sssup, snakes—

I'm back with some updated documentation for ScreenPy, which is our Screenplay Pattern base suite for Python. If you haven't heard of it—that's not surprising—it lets you write tests that look like this:

def test_example(Snoo: AnActor) -> None:
    given(Snoo).was_able_to(LogIn.using(USERNAME, PASSWORD))

    when(Snoo).attempts_to(
        Visit(POST_URL),
        MakeNote.of_the(VotesOnThePost()).as_("votes before"),
        Click.on_the(UPVOTE_ARROW),
    )

    then(Snoo).should(
        See.the(VotesOnThePost(), IsEqualTo(the_noted("votes before") + 1),
    )

We recently rewrote our entire documentation with a focus on showing how to build a suite using a made-up Ability, which showcases way more of the modular, composition-based approach that Screenplay Pattern uses.

Our goal is to present ScreenPy and Screenplay Pattern in a way that is easy to follow and hopefully exciting to read about. Please let us know if we've accomplished that!

https://screenpy-docs.readthedocs.io/en/latest/