Skip to content

An adapter for the microphone of ScreenPy's Narrator which sends logs to Allure.

License

Notifications You must be signed in to change notification settings

ScreenPyHQ/screenpy_adapter_allure

Repository files navigation

ScreenPy Adapter: Allure

Build Status Build Status

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

TITLE CARD:
                         "ScreenPy Adapter: Allure"
TITLE DISAPPEARS.
                                                                      FADE IN:
INT. DOCUMENTATION - UNKNOWN TIME

A recording room door opens and AUDIENCE peeks inside. AUDIENCE quietly steps
over cords and around chairs, approaching the switchboard. NARRATOR quietly
resumes their guidance.

                              NARRATOR (V.O.)
            Ah, this is one of the Adapters for my microphone. This
            one sends them to an Allure report.

                              AUDIENCE
                              (hushed)
            You mean you have a literal microphone, and that's how
            you're talking to me? I thought I had been stingy to
            some tester and you were the first of three spirits.

                              NARRATOR (V.O.)
            Not a literal microphone, but it's a helpful metaphor.

                              AUDIENCE
                              (hushed)
            That's not as helpful as you think it is, when your
            voice is in my head.

A beat, as AUDIENCE looks appraisingly at the equipment.

                              AUDIENCE (CONT'D)
                              (hushed)
            This looks complicated. I'm leaving now.

                              NARRATOR (V.O.)
            Let's turn left outside the door...

                                                                      FADE OUT

Installation

pip install screenpy_adapter_allure

or

pip install screenpy[allure]

Documentation

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

You can also read the ScreenPy Docs for more information about ScreenPy in general.

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! :)

About

An adapter for the microphone of ScreenPy's Narrator which sends logs to Allure.

Resources

License

Stars

Watchers

Forks

Packages

No packages published