Skip to content

An extension for ScreenPy that enables interacting with Requests.

License

Notifications You must be signed in to change notification settings

ScreenPyHQ/screenpy_requests

Repository files navigation

ScreenPy Requests

Build Status Build Status

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

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

AUDIENCE enters from a hidden door built into a bookcase, blinking their eyes
as they adjust to the relative darkness. Dimly lit shelves hold gizmos and
gadgets which give off a secretive air. NARRATOR continues.

                              NARRATOR (V.O.)
            ... these gathered curios enable your ScreenPy
            Actors to make API requests using the Requests
            library.

                              AUDIENCE
            These things look like they weren't meant to be seen.
            Will it be OK to expose them like this?

                              NARRATOR (V.O.)
            You could consider the "front end" to be an End User,
            of sorts. Then your Actors are simply a stand-in for
            your front end application.

                              AUDIENCE
            In that case, anything could be an End User, if I
            need them to be.

                              NARRATOR (V.O.)
            Now you're getting it. Come this way, there are more...

                                                                      FADE OUT

Installation

pip install screenpy_requests

or

pip install screenpy[requests]

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 extension for ScreenPy that enables interacting with Requests.

Resources

License

Stars

Watchers

Forks

Packages

No packages published