quyk 0.1.1

An uncomplicated package to test decorated functions directly from your terminal

quyk

An uncomplicated tool to test decorated functions directly from your terminal.

Installation

Install quyk into you project directory.

pip install quyk

or

poetry add quyk

Usage

Import one decorator and apply it to any functions you want to test from the command line:

from quyk import cli_test

@cli_test(test_args=("foo", "bar"))
def stitch_together(*args):
	return f"stitched {'-'.join(args)}"
# ...

Scan all .py files in your project for decorated functions:

$ quyk scan							# default to entire current directory
> ⠙ Scanning directory
> ✔ Found 4 decorated functions 

... or hone into a specific folder:

$ quyk scan ./tricky_feature		# optionally provide [dir_path]
> ⠙ Scanning directory
> ✔ Found 2 decorated functions 

Interactively run your scanned tests:

$ quyk test							# use Arrows, Enter, and Escape to pick a test 
> [?] Select a function to test: 
   > stitch_together
     do_something
     do_something_else
> stitch_together: stitched foo-bar

... or directly test a specific function

$ quyk test do_something			# optionally provide [func_name]
> do_something: This thing!

Or export the runnable test files and edit them to your liking:

$ quyk export						# optionally pass [dir_path] to place test files there
> ⠋ Exporting tests
> ✔ Test files exported to /path/to/project/quyk_tests

---

That's it!