README.txt

Participating
=============
Fork this repo with the Fork button in the top right.

Now clone your local copy using a command like:

    $ git clone git@github.com:YOURNAME/pyssignments.git

After you make the changes to fix the tests on your local copy, commit and then
push them to your github account with:

    $ git push origin master

Now you can email the URL to your repo to your instructors for grading.

To prepare for future assignments you will want to run:

    $ git remote add upstream git://github.com/ericrasmussen/pyssignments.git

We will provide additional instructions when new assignments become available.


Virtual Environment
===================
Install virtualenv if you don't already have it. More information here:
   http://pypi.python.org/pypi/virtualenv

Once installed, change to your <repo> folder and run:

   $ virtualenv .
   $ source bin/activate
   $ python setup.py develop

Now you can run the python and nosetests commands in an isolated environment
that won't affect the system level commands.


Running Tests
=============
After you activate your virtual environment (see above), navigate to
<repo>/pyssignments/ and run:

    $ nosetests assignment<number>

You should see output showing failed tests and tracebacks with details. You can
use that information to update the code. Keep re-running the tests as you make
changes to the code.