Skip to main content

Screenplay pattern base for Python automated test suites.

Project description

ScreenPy

Build Status Build Status

Supported Versions Checked with mypy Code style: black Imports: isort Ruff

TITLE CARD:
                                  "ScreenPy"
TITLE DISAPPEARS.
                                                                      FADE IN:
INT. DOCUMENTATION - NIGHT

Illuminated by the computer's glow, AUDIENCE sits reading the documentation
for a Python library they haven't seen before. AUDIENCE is visibly startled
as a dulcet voice begins to speak.

                              NARRATOR (V.O.)
            ScreenPy is a library that provides the base for an
            automated test suite using Screenplay Pattern.

                              AUDIENCE
            Wha- who are you? Where are you? And... what is
            Screenplay Pattern?!

                              NARRATOR (V.O.)
            It's a composition-based architecture pattern,
            encouraging automated test writers to write more
            maintainable test suites. It allows test writers to
            use Gherkin-style language in Python to create
            descriptive UI tests.

                              AUDIENCE
                              (reluctantly)
            Ignoring how you avoided answering my first questions,
            how do I get started?

                              NARRATOR (V.O.)
            I thought you'd never ask...

                                                                      FADE OUT

Installation

pip install screenpy

Documentation

Please check out the Read The Docs documentation for the latest information about this module!

Contributing

You want to contribute? Great! Here are the things you should do before submitting your PR:

  1. Fork the repo and git clone your fork.
  2. dev install the project package:
    1. pip install -e .[dev]
    2. Optional (poetry users):
      1. poetry install --extras dev
  3. Run tox to perform tests frequently.
  4. Create pull-request from your branch.

That's it! :)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

screenpy-5.0.0.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

screenpy-5.0.0-py3-none-any.whl (58.5 kB view details)

Uploaded Python 3

File details

Details for the file screenpy-5.0.0.tar.gz.

File metadata

  • Download URL: screenpy-5.0.0.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for screenpy-5.0.0.tar.gz
Algorithm Hash digest
SHA256 c283c0e544ade6e286b70281cac1eec0dde4fa90ee6e058c1d39cd521066d85e
MD5 7c0482594ece45b6d669032ab8e2d335
BLAKE2b-256 ba9df37bbde3af8fb4b01db90cff81c951971ed0dc89852755eb612c524fe484

See more details on using hashes here.

Provenance

The following attestation bundles were made for screenpy-5.0.0.tar.gz:

Publisher: publish.yml on ScreenPyHQ/screenpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file screenpy-5.0.0-py3-none-any.whl.

File metadata

  • Download URL: screenpy-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 58.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for screenpy-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0333f7395cdd0fc8fc6700b090510f6a2452f6a1953690b0ec11048c91d3c2cf
MD5 0bada6c453ed9eb08490f9796e64deee
BLAKE2b-256 ec16de99b99e0859e1a9fed7f5430568eb3af3a328698fd3d9648ec5206792d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for screenpy-5.0.0-py3-none-any.whl:

Publisher: publish.yml on ScreenPyHQ/screenpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page