Hey all, Version 3.2.9 is the last version hosted from this repository. Starting at version 4.0.0, ScreenPy is hosted at ScreenPyHQ's fork.
This change is because, starting with version 4.0.0, ScreenPy is broken up by the Abilities provided to the Actors. This will both allow for better organization of Actions and better exemplify the compositional nature of this framework.
This major version bump will be very disruptive, so i'll support versions 3.x from this repo.
See you all at ScreenPyHQ!
ScreenPy
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!
Quickstart
Once installed, to set up a Screenplay Pattern scaffolding in your project, cd to the folder you will use for your suite and run this command:
screenpy-quickstart
Note that the Python script directory will need to be on your path to find screenpy-quickstart.
This will set up user_interface, tasks, and features directories and fill them with a simple test. For explanations on what these directories are for, see the File Hierarchy documentation
Allure Integration
ScreenPy utilizes Allure to document the action. If you would like to see an allure report of your Screenplay Suite, run the test using PyTest like so:
python -m pytest features --alluredir allure_report
allure serve allure_report
Contributing
You want to contribute? Great! Here are the things you should do before submitting your PR:
- Install
pre-commit - run
pre-commit installonce. - run
toxto perform tests frequently.
That's it! :)