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 pre-commit install once.
  4. Run tox to perform tests frequently.
  5. 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-4.2.5.tar.gz (36.0 kB view details)

Uploaded Source

Built Distribution

screenpy-4.2.5-py3-none-any.whl (57.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for screenpy-4.2.5.tar.gz
Algorithm Hash digest
SHA256 05f0cc6ebf2a4bdcb80783fe57b41736d87a9673cabce5825a6927a990097b79
MD5 45080aed8512cf0d5bcdfbafdc53f4b0
BLAKE2b-256 d41ae0e3bfb01639b72e07083fca5297515a60a59db7f3175c98980491d17dc0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for screenpy-4.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fd7f09c51ec4f78a4b8410e882b074d464cf49a42227aa74d9cf864b18541c79
MD5 70652693956f1a9e6aec07661442f9e6
BLAKE2b-256 278388cc3a16a0883ef281c1ad799e15a8630c6fbeb1b422fb03e7c55edb6b55

See more details on using hashes here.

Supported by

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