Getting Started

Installation

Install prysk globally using pip:

python -m pip install -U prysk

or install it into the user site:

python -m pip install -U --user prysk

Create your first test

1. Create an empty folder for your tests

   $ mkdir -p tests
   

2. Change into the test directory

   $ cd tests
   

3. Create an empty prysk test file

   $ touch my_test.t
   

4. Add the following content to your test file

   This is a comment
   
       $ echo "foo bar"
   

5. If you run the test now you should get a failure

   $ prysk my_test.t
   !
   --- my_test.t
   +++ my_test.t.err
   @@ -1,3 +1,4 @@
    This is a comment
   
      $ echo "foo bar"
   +  foo bar
   
   # Ran 1 tests, 0 skipped, 1 failed.
   

   In order to define the test assumption you can make use of the interactive mode -i to get yourself jump started

6. Use the interactive mode to define the initial assumptions

   $ prysk -i my_first_test.t
   !
   --- my_test.t
   +++ my_test.t.err
   @@ -1,3 +1,4 @@
    This is a comment
   
      $ echo "foo bar"
   +  foo bar
   Accept this change? [yN]
   

   Confirm with y and check our test file my_test.t afterwards.

7. Check if your test file my_test.t was updated

   $ cat my_first_test.t
      $ echo "foo bar"
      foo bar
   

8. If you run your test again, it should pass now just fine

   $ prysk -i my_first_test.t
   .
   # Ran 1 tests, 0 skipped, 0 failed.