Skip to content
Branch: master
Find file History
Pull request Compare This branch is 308 commits ahead, 40 commits behind udacity:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
README.md
tournament.py
tournament.sql
tournament_test.py

README.md

Project 2: Tournament Results

by Steven Wooding

Tournament Results project, part of the Udacity Full Stack Web Developer Nanodegree.

What it is and does

A Python program and PostgreSQL database that produces pairings and standings of players taking part in a tournament run under the Swiss-system of organising a tournament.

Required Libraries and Dependencies

The project code requires Python 2.7.x and that the Psycopg package is available on your system for import. It also requires PostSQL 9.3 or higher.

You can run the project in a Vagrant managed virtual machine (VM) which includes all the required dependencies (see below for how to run the VM). For this you will need Vagrant and VirtualBox software installed on your system.

Project contents

This project consists for the following files:

  • tournament.sql - Creates the database, defines tables and views
  • tournament.py - Contains functions that implement the Swiss-system
  • tournament_test.py - Contains unit tests to test the functions in tournament.py

How to Run the Project

Download the project zip file to you computer and unzip the file. Or clone this repository to your desktop.

Open the text-based interface for your operating system (e.g. the terminal window in Linux, the command prompt in Windows).

Navigate to the project directory and then enter the vagrant directory.

Bringing the VM up

Bring up the VM with the following command:

vagrant up

The first time you run this command it will take awhile, as the VM image needs to be downloaded.

You can then log into the VM with the following command:

vagrant ssh

More detailed instructions for installing the Vagrant VM can be found here.

Make sure you're in the right place

Once inside the VM, navigate to the tournament directory with this command:

cd /vagrant/tournament

Initialise the database

On the first time you go through these instructions, you need to initialise the database with the following command:

psql -c '\i tournament.sql'

On later readings you can leave this step out, unless you have deleted the VM in the mean time. Then by all means, do this step again.

It doesn't really hurt to do this step again, but it does delete the database and recreates it from scratch.

Running the tournament unit tests

You can then run the unit tests for the project with the following command:

python tournament_test.py

All tests should pass successfully.

Shutting the VM down

When you are finished with the VM, press Ctrl-D to logout of it and shut it down with this command:

vagrant halt

Extra Credit Description

The Swiss-system algorithm avoids rematches between players during a tournament.

An odd number of players in a tournament is handled by given one player per round a bye (a free win). A player can only get a bye once in a tournament.

Miscellaneous

This README document is based on a template suggested by PhilipCoach in this Udacity forum post.

The function all_pairs() was written by gatoatigrado (Stack Overflow username) and the original can be found here. I have explained how this function works and why it is needed in the docstring for the function. I have also added comments to the code.

You can’t perform that action at this time.