Merge branch 'master' of github.com:RunestoneInteractive/thinkcspy

Author: bnmnetp

.gitignore

@@ -16,3 +16,6 @@ sphinx-enki-info.txt
 sphinx_settings.json
 output.log
 beta
+output
+published
+pdf

Makefile

@@ -2,7 +2,7 @@ export BOOKDIR=$(HOME)/Runestone/books/thinkcspy
 export COMPDIR=$(HOME)/Runestone/RunestoneComponents
 export RSURI = https://runestone.academy/cdn/runestone/
 
-.PHONY: pretext html pdf
+.PHONY: pretext html pdf runestone
 
 help:
 	@echo "Unless you are converting RST to PTX you you should use this Makefile!!!!"
@@ -32,3 +32,8 @@ html:
 pdf:
 	python ~/src/pretext/pretext/pretext -c all -f pdf -p $(BOOKDIR)/pretext/publication-rs-for-all.xml -x debug.rs.services.file /Users/bmiller/Runestone/RunestoneComponents/runestone/dist/webpack_static_imports.xml -d $(BOOKDIR)/pdf $(BOOKDIR)/pretext/thinkcspy.ptx 
 
+runestone:
+	python ~/src/pretext/pretext/pretext -c all -f html -p $(BOOKDIR)/pretext/publication-rs-academy.xml  -d $(BOOKDIR)/runestone $(BOOKDIR)/pretext/thinkcspy.ptx 
+	
+profile:
+	python -m cProfile -s cumulative  ~/src/pretext/pretext/pretext -c all -f html -p $(BOOKDIR)/pretext/publication-rs-for-all.xml  -d $(BOOKDIR)/beta $(BOOKDIR)/pretext/thinkcspy.ptx 

README.rst

@@ -32,11 +32,18 @@ Building with PreTeXt
 
 1. Create a virtual environment
 2. pip install pretextbook
-3. To build run: pretext build --input pretext/thinkcspy.ptx --output output --format html --publication pretext/publication-rs-for-all.xml
+3. To build run: pretext build web
 4. pretext view html
 
 Note: The pretext sources are in the pretext folder, we will keep the _sources folder until we are 100% sure that the book has been converted correctly and as thoroughly as possible.
 
+Building for Production on a Runestone Server
+---------------------------------------------
+
+1. clone this repo to `httlacs` instead of `thinkcspy`
+2. Run `rsmanage addcourse` and add `httlacs` as course name and base course name
+3. Run `rsmanage build --ptx httlacs`
+
 
 Building with runestone
 -----------------------

_sources/UnitTesting/TestingWithpytest.rst

@@ -66,9 +66,9 @@ Here's an example of how it works:
                     except Exception as e:
                         self.assertEqual(item + " failed", item + " passed", item + " failed: " + str(e))
 
-    pyTests().main() 
+    pyTests().main()
+
 
-    
 .. test:
 
     success = True
@@ -82,15 +82,15 @@ Here's an example of how it works:
 
     if success:
         print("All tests passed!")
-        
+
 This code example defines two functions: the function to be tested, ``round6``, and a function named ``test_round6``
 that contains unit test code. When using the pytest approach, you write your unit test as a function whose name must
 start with the prefix ``test_``. Inside the function, you write normal assert statements to test the desired function.
 Notice that you do not write a line to *call* the unit test function. Instead, when you launch pytest to run the unit
-tests, pytest scans your script and executes only the functions with the prefix ``test_``. 
+tests, pytest scans your script and executes only the functions with the prefix ``test_``.
 
 This ActiveCode environment simulates pytest by scanning for and executing functions with a ``test_`` prefix when you
-click **Run**. Go ahead and try it - rename the test_round6 function to ``test_itworks`` and try running the test again. 
+click **Run**. Go ahead and try it - rename the test_round6 function to ``test_itworks`` and try running the test again.
 
 Organizing pytest Functions
 ---------------------------
@@ -121,11 +121,11 @@ Using pytest
 ------------
 
 To use pytest, you must first install it using the **pip** command. Open your computer's command line window
-(not the Python interpreter) and enter the following command to install: 
+(not the Python interpreter) and enter the following command to install:
 
 * Windows::
 
-    pip install pytest 
+    pip install pytest
 
 * Mac/Linux::
 
@@ -151,7 +151,7 @@ When you run the pytest command and an assertion fails, you see a report like th
     >       assert round6(8.5) == 8
     E       assert 9 == 8
     E        +  where 9 = round6(8.5)
-                                                                            
+
     myround.py:8: AssertionError
 
 Let's take a closer look at this report to understand what it's telling you.
@@ -168,15 +168,15 @@ Let's take a closer look at this report to understand what it's telling you.
        E        +  where 9 = round6(8.5)
 
    This indicates that the call to ``round6(8.5)`` returned the value 9, instead of the value 8.
-   The value ``9`` is the actual result of the function. Knowing the value actually produced by 
+   The value ``9`` is the actual result of the function. Knowing the value actually produced by
    the function can help you to troubleshoot the bug and correct the problem.
 
 Integrated Unit Testing with pytest
 ------------------------------------
 
 When you use the pytest framework, you can include pytest test functions in your main program, along with the rest of
 your program code. This allows you to keep your tests together with the functions that they test, and you can run either
-your program (using the python command) or the unit tests (using the pytest command). 
+your program (using the python command) or the unit tests (using the pytest command).
 
 Take a look at this example that shows a function (``round6``, containing a bug), together with a
 unit test function (``test_round6``), and a main program that uses ``round6``:
@@ -234,7 +234,7 @@ sense, just remember: in order for pytest to work correctly, any code that is pa
                     """
             ~~~~
             # Write a pytest unit test function named ``test_grade``
-            
+
 
             ====
             from unittest.gui import TestCaseGui
@@ -247,7 +247,7 @@ sense, just remember: in order for pytest to work correctly, any code that is pa
             def grade(score):
                 global illegal, testA, testB, testF
 
-                if score > 100 or score < 0:
+                if score > 100 or score < 0:
                     illegal = True
                     return ''
                 elif score >= 90:
@@ -276,13 +276,13 @@ sense, just remember: in order for pytest to work correctly, any code that is pa
 
         The following is a suggested pytest unit test.
 
-        .. sourcecode:: 
-            
+        .. sourcecode::
+
             def test_grade():
                 assert grade(92) == 'A'
                 assert grade(85) == 'B'
                 assert grade(69) == 'F'
 
-                
+
 
 

pretext/Appendices/foo

@@ -0,0 +1,25 @@
+<section xml:id="appendices_test-module-source-code">
+        <title><c>test</c> module source code</title>
+        <p>Starting in the Functions chapter, we have written unit tests using the <c>testEqual</c> function from
+            the <c>test</c> module. This test module is not included in the standard Python distribution. (There is
+            a standard test module but it is different from this.) What follows is the source code for this <c>test</c> module.</p>
+        <program language="python"><input>
+def testEqual(actual,expected,places=5):
+    '''
+    Does the actual value equal the expected value?
+    For floats, places indicates how many places, right of the decimal, must be correct
+    '''
+    if isinstance(expected,float):
+        if abs(actual-expected) &lt; 10**(-places):
+            print('\tPass')
+            return True
+    else:
+        if actual == expected:
+            print('\tPass')
+            return True
+    print('\tTest Failed: expected {} but got {}'.format(expected,actual))
+    return False
+</input></program>
+        <p>To use this module when programming on your own computer, save the above code with the name <term>test.py</term> in the same folder as the python program you want to test.</p>
+    </section>
+

pretext/ClassesBasics/Exercises.ptx

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <exercises xml:id="classes-basics_exercises">
   <title>Exercises</title>
-  <exercise xml:id="classes_q1">
+  <exercise label="classes_q1">
     <statement>
       <p>Add a <c>distanceFromPoint</c> method that works similar to <c>distanceFromOrigin</c> except that it
                         takes a <c>Point</c> as a parameter and
@@ -46,7 +46,7 @@ print(p.distanceFromPoint(q))
       </program>
     </solution>
   </exercise>
-  <exercise xml:id="ch_cl_02">
+  <exercise label="ch_cl_02">
     <statement>
       <p>Add a method <c>reflect_x</c> to Point which returns a new Point, one which is the
                 reflection of the point about the x-axis.  For example,
@@ -58,7 +58,7 @@ print(p.distanceFromPoint(q))
         </input>
     </program>
   </exercise>
-  <exercise xml:id="classes_q3">
+  <exercise label="classes_q3">
     <statement>
       <p>Add a method <c>slope_from_origin</c> which returns the slope of the line joining the origin
                         to the point.   For example,</p>
@@ -104,7 +104,7 @@ print(p.slope_from_origin())
       </program>
     </solution>
   </exercise>
-  <exercise xml:id="ch_cl_04">
+  <exercise label="ch_cl_04">
     <statement>
       <p>The equation of a straight line is  <q>y = ax + b</q>, (or perhaps <q>y = mx + c</q>).
                 The coefficients a and b completely describe the line.  Write a method in the
@@ -122,7 +122,7 @@ print(p.slope_from_origin())
         </input>
     </program>
   </exercise>
-  <exercise xml:id="classes_q5">
+  <exercise label="classes_q5">
     <statement>
       <p>Add a method called <c>move</c> that will take two parameters, call them <c>dx</c> and <c>dy</c>.  The method will
                         cause the point to move in the x and y direction the number of units given. (Hint: you will change the values of the
@@ -169,7 +169,7 @@ print(p)
       </program>
     </solution>
   </exercise>
-  <exercise xml:id="classes_q6">
+  <exercise label="classes_q6">
     <statement>
       <p>Given three points that fall on the circumference of a circle, find the center and radius of the circle.</p>
     </statement>

pretext/ClassesBasics/UserDefinedClasses.ptx

@@ -125,7 +125,7 @@ alex = Turtle()
   <p>
     <term>Check Your Understanding</term>
   </p>
-  <exercise xml:id="chp17_objects">
+  <exercise label="chp17_objects">
     <statement>
       <p>What is the the output of the following print code?</p>
       <program language="python">

pretext/ClassesDiggingDeeper/Exercises.ptx

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <exercises xml:id="classes-digging-deeper_exercises">
   <title>Exercises</title>
-  <exercise xml:id="classes_deeper_q1">
+  <exercise label="classes_deeper_q1">
     <statement>
       <p>We can represent a rectangle by knowing three things: the location of its lower left corner, its width, and its height.
                         Create a class definition for a Rectangle class using this idea.  To create a Rectangle object at location (4,5) with width 6
@@ -50,7 +50,7 @@ print(r)
       </program>
     </solution>
   </exercise>
-  <exercise xml:id="ch_cl2_q2">
+  <exercise label="ch_cl2_q2">
     <statement>
       <p>Add the following accessor methods to the Rectangle class: <c>getWidth</c>, <c>getHeight</c>, <c>__str__</c>.</p>
     </statement>
@@ -60,7 +60,7 @@ print(r)
         </input>
     </program>
   </exercise>
-  <exercise xml:id="ch_cl2_q3">
+  <exercise label="ch_cl2_q3">
     <statement>
       <p>Add a method <c>area</c> to the Rectangle class that returns the area of any instance:</p>
       <pre>r = Rectangle(Point(0, 0), 10, 5)
@@ -107,7 +107,7 @@ class Rectangle:
       </program>
     </solution>
   </exercise>
-  <exercise xml:id="ch_cl2_q4">
+  <exercise label="ch_cl2_q4">
     <statement>
       <p>Write a <c>perimeter</c> method in the Rectangle class so that we can find
                 the perimeter of any rectangle instance:</p>
@@ -120,7 +120,7 @@ test(r.perimeter(), 30)</pre>
         </input>
     </program>
   </exercise>
-  <exercise xml:id="ch_cl2_q5">
+  <exercise label="ch_cl2_q5">
     <statement>
       <p>Write a <c>transpose</c> method in the Rectangle class that swaps the width
                         and the height of any rectangle instance:</p>
@@ -174,7 +174,7 @@ class Rectangle:
       </program>
     </solution>
   </exercise>
-  <exercise xml:id="ch_cl2_q6">
+  <exercise label="ch_cl2_q6">
     <statement>
       <p>Write a new method in the Rectangle class to test if a Point falls within
                 the rectangle.  For this exercise, assume that a rectangle at (0,0) with
@@ -196,7 +196,7 @@ test(r.contains(Point(-3, -3)), False)</pre>
         </input>
     </program>
   </exercise>
-  <exercise xml:id="ch_cl2_q7">
+  <exercise label="ch_cl2_q7">
     <statement>
       <p>Write a new method called <c>diagonal</c> that will return the length of the diagonal that runs
                         from the lower left corner to the opposite corner.</p>
@@ -244,7 +244,7 @@ class Rectangle:
       </program>
     </solution>
   </exercise>
-  <exercise xml:id="ch_cl2_q8">
+  <exercise label="ch_cl2_q8">
     <statement>
       <p>In games, we often put a rectangular <q>bounding box</q> around our sprites in
                 the game.  We can then do <em>collision detection</em> between, say, bombs and

pretext/Debugging/HowtoAvoidDebugging.ptx

@@ -66,7 +66,7 @@ print(final_time)
         </input>
   </program>
   <p>Hmm, when you run this example you see that something unexpected has happened. You would not realize this was an error unless you first knew what the program was supposed to do.</p>
-  <exercise xml:id="db_q_ex3_1">
+  <exercise label="db_q_ex3_1">
     <statement>
       <p>Which of the following best describes what is wrong with the  previous example?</p>
     </statement>

pretext/Debugging/KnowyourerrorMessages.ptx

@@ -34,7 +34,7 @@ print(final_time_int)
                 Python interpreter. The interpreter in activecode is limited in many ways, but it is intended for beginners,
                 including the wording chosen to describe errors.</p>
   </note>
-  <exercise xml:id="db_qex32">
+  <exercise label="db_qex32">
     <statement>
       <p>Which of the following explains why <c>wait_time_int = int(wait_time_int)</c> is an error?</p>
     </statement>