add INSTALL.txt, bin/tpath and tpath.bat

revise directions in bin/README.md, notes/test.txt and release-1.0.txt
revise setup.py to install bin/tpath
add docstring to pymodel/__init__.py
INSTALL.txt just started, still incomplete

Author: jon-jacky

INSTALL.txt

@@ -0,0 +1,28 @@
+
+To use PyModel, you do not need to install anything into any system
+directories.  Just obtain the PyModel directory and place it at any
+convenient location.  To get the current development version,
+
+ git clone git@github.com:jon-jacky/PyModel.git
+
+To get version 1.0, download PyModel-1.0.tar.gz or PyModel-1.0.zip
+from
+
+ https://pypi.python.org/pypi/PyModel 
+
+or 
+
+ http://staff.washington.edu/jon/pymodel/www/
+
+Then unpack ...
+
+... execute pymodel_paths ...  rename PyModel-1.0 to just PyModel (or 
+edit the commands) ...
+
+The setup.py script now supports the install argument, to optionally
+install the PyModel python modules and commands in system directories.
+
+... source tpath ...
+
+... install does not do anything with samples or docs ...
+

MANIFEST.in

@@ -3,7 +3,7 @@ recursive-include notes *.txt *.rst *.md
 recursive-include talks *.txt *.rst *.md *.pdf
 recursive-include www *.txt *.rst *.md *.html 
 recursive-include pymodel *.txt *.rst *.md *.py
-recursive-include bin *.txt *.rst *.md *.bat clogdiff tdiff tclean dotpdf dotps dotsvg pma pmg pmt pmv pymodel_paths tpath trun wsgirunner
+recursive-include bin *.txt *.rst *.md *.bat clogdiff tpath trun tdiff tclean dotpdf dotps dotsvg pma pmg pmt pmv pymodel_paths wsgirunner
 recursive-include samples *.txt *.rst *.md *.bat *.py *.ref *.svg *.pdf *.ps
 
 

bin/README.md

@@ -66,4 +66,8 @@ The commands are:
     *.py* files in *PyModel/pymodel* without typing the *.py*
     extension on the command line.
 
-Revised Apr 2013
+- *tpath*: puts the current directory on *PYTHONPATH*, alternative
+  to *pymodel_paths* to use when PyModel is installed in system directories,
+  might still be needed even then.  See *test.txt* in the *notes* directory
+
+Revised May 2013

bin/tpath

@@ -0,0 +1,2 @@
+# put the current directory on PYTHONPATH
+export PYTHONPATH=.:$PYTHONPATH

bin/tpath.bat

@@ -0,0 +1,2 @@
+rem put the current directory on PYTHONPATH
+set PYTHONPATH=.:%PYTHONPATH%

notes/release-1.0.txt

@@ -46,6 +46,10 @@ Version 1.0 adds new functionality:
 - The new command tclean removes test output files from the 
   current directory.
 
+- The revised setup.py now supports the install argument, to
+  optionally install the PyModel python modules and commands in system
+  directories.
+
 Version 1.0 adds a new sample and revises all the others:
 
 - The completely rewritten Socket sample includes new asynchronous

notes/test.txt

@@ -9,8 +9,8 @@ distribution, including the tests of all the samples.  These scripts
 demonstrate the samples, as well as testing PyModel itself.
 
 These notes describe our unit tests, along with our little homemade
-unit testing commands: trun, tdiff, and tclean.  These commands are
-independent of the rest of PyModel (they could be used to test any
+unit testing commands: tpath, trun, tdiff, and tclean.  These commands
+are independent of the rest of PyModel (they could be used to test any
 program that writes to stdout).  We use these (instead of a
 conventional unit test framework like unittest or nose) because:
 
@@ -24,25 +24,34 @@ conventional unit test framework like unittest or nose) because:
 The last section (below) explains how to script tests similar to ours
 using the unittest module from the Python standard library.
 
-These directions apply to both Windows and Unix-like systems
-(including Linux and Mac OS X).  The directions assume that Python is
-already installed and your environment is configured so you can run it
-(if not, see http://docs.python.org/2/using/).  It also assumes that
-PyModel is present on your system, the contents of its PyModel/pymodel
-directory are on your Python path, the current directory is on your
-Pyton path, and the contents of its PyModel/bin directory are on your
-execution path.  You can achieve this by executing
-PyModel/bin/pymodel_paths, or the commands therein.
-
-Quick Start
-Summary
+Prerequisites
+Running tests
+Command summary
 Commands and modules
 Test scripts
 Checking test script output
 Output files
 Using other unit testing frameworks
 
-Quick Start
+
+Prerequisites
+
+These directions apply to both Windows and Unix-like systems
+(including Linux and Mac OS X).  The directions assume that Python is
+already installed and your environment is configured so you can run it
+(if not, see http://docs.python.org/2/using/).  It also assumes that
+the upacked PyModel directories are present on your system, the
+contents of its PyModel/pymodel directory are on your Python path, the
+contents of its PyModel/bin directory are on your execution path, and
+your current directory is on your Python path.  You can achieve this
+by executing PyModel/bin/pymodel_paths, or the commands therein.
+Alternatively, you can install the contents of PyModel/pymodel and
+PyModel/bin into system directories (see INSTALL.txt) but then you may
+need to execute the command "source tpath" in each session (terminal
+window) before you execute any PyModel commands.
+
+
+Running tests
 
 In each subdirectory of samples, type:
 
@@ -59,11 +68,13 @@ script is not deterministic and the tdiff command is not meaningful
 -- instead just run trun test (or whatever).
 
 
-Summary
+Command Summary
 
 commands in bin directory
-  trun      - execute test script module
-  tdiff     - execute test script, compare output to reference
+  tpath     - put current directory on PYTHONPATH, needed by trun
+  tpath.bat - ditto, batch script for Windows
+  trun      - execute test script module named in argument
+  tdiff     - execute command (usually trun ...), compare output to reference
   tdiff.bat - ditto, batch script for Windows
   tclean    - remove output files created by running test scripts
   tclean.bat - ditto, batch script for Windows
@@ -76,6 +87,7 @@ Programs and scripts in the pymodel directory
   trun.py - executes test script module given as argument
 
 In each model directory: samples/PowerSwitch,  samples/WebApplication/Model,...
+
   test.py - test script module, executed by trun
   test.log - most recent output from test.py, including stdout and stderr, 
               saved by tdiff 
@@ -89,6 +101,7 @@ In each model directory: samples/PowerSwitch,  samples/WebApplication/Model,...
           dot scripts (maybe via pmv.py), moved here by hand
   pdf/ -  ditto, .pdf (not many of these), moved here by hand
 
+
 Programs, Modules, and Commands
 
 In these notes, "the foo module" or "the foo program" means the Python
@@ -222,6 +235,7 @@ If a test case crashes (raises an unhandled exception) on Windows, the
 traceback goes to the screen, not the log file.  I can't find anything
 in Windows like Unix >& to redirect error output also.
 
+
 Output files
 
 The PyModel pmt command only writes to the terminal (to stdout and

pymodel/__init__.py

@@ -0,0 +1,3 @@
+"""
+Make this directory a package so it can be installed with one line in setup.py
+"""

setup.py

@@ -32,10 +32,10 @@
     author_email = 'jon.p.jacky@gmail.com',
     maintainer = 'Jonathan Jacky',
     maintainer_email = 'jon.p.jacky@gmail.com',
-    url = 'http://staff.washington.edu/jon/pymodel/www/',
+    url = 'https://github.com/jon-jacky/PyModel',
     description = 'Model-based testing in Python',
     long_description = open('README.md').read(),
-    download_url = 'http://staff.washington.edu/jon/pymodel/www/',
+    download_url = 'https://pypi.python.org/pypi/PyModel',
     license = 'BSD License',
 
     packages = ['pymodel'],
@@ -60,6 +60,8 @@
                 'bin/tclean.bat', 
                 'bin/tdiff', 
                 'bin/tdiff.bat', 
+                'bin/tpath', 
+                'bin/tpath.bat', 
                 'bin/trun', 
                 'bin/wsgirunner', ],