Importing Initial Data¶
Once you’ve got Tabbycat installed, the next step is to import data for the tournament. The initial import requires details of all institutions, teams, speakers and adjudicators, and specifications for how many rounds and their properties. We don’t currently have a way of doing this from the web interface. There are a few ways to do it.
With any method, the objective is to create one
Tournament object, and then the
AdjudicatorInstitutionConflict objects for each round, venue, and so on
Creating a tournament¶
Immediately after you install Tabbycat and create a user account the site will prompt you to Create a New Tournament. Filling in the information here will create the basic tournament, round, and break information needed; leaving you to enter the other data (teams, adjudicators, venues, etc.) using any of the below methods.
If you are just learning, trying, or experimenting with Tabbycat we offer two types of demo datasets on this Create Page. Clicking either will create a new tournament fully populated with all the teams, speakers, institutions, etc. needed to immediately start running rounds.
For sufficiently small tournaments, you might just choose to edit the database via the Django administrative interface (under Setup > Edit Database).
The Django administrative interface is very powerful, and naturally if you mess things up, you can insert potentially catastrophic inconsistencies into the database. When you’re setting up a tournament for the first time, this is highly unlikely to happen, but it’s worth keeping in mind.
- Open up your the admin area of your site by going to the URL with /admin/ on the end, e.g. if your URL root is 127.0.0.1:8000, then http://127.0.0.1:8000/admin/.
- Then click Tournaments and then Tournaments in the sidebar.
- Create a new Tournament object, and input all of its rounds
- Create the Venues (under Venues > Venues)
- Create the Institutions (under Participants > Institutions)
- Create the Teams, and input their speakers (under Participants > Teams)
- Create the Adjudicators, and input their conflicts (under Participants > Adjudicators)
For medium sized tournaments there are a number of tools that allow you to import information by copy and pasting from spreadsheets. Or by adding data in bulk and editing key information later.
- Open the “Import Data” area of the site under the Setup link in the menu (once your have created a tournament and logged in)
- Follow the instructions for each particular section
If copy-pasting from a spreadsheet, it is often easiest to make values be separated by commas by saving the spreadsheet as a *.csv file, then opening said file in a plain text editor (such as Notepad or TextEdit) and copy/pasting from there.
We’ve written a management command called
importtournament to help automate the tournament set-up. The script, however, is neither foolproof nor comprehensive, so you might find you need to modify things slightly if your tournament structure is different from ours. Be prepared to try this a few times to get it to work. Nonetheless, this is probably the fastest way to set up a tournament.
- Copy and rename the
- See the CSV files in the new folder, and add/replace the data as per your tournament. Note that the institutions (i.e. first column) in the
adjudicators.csvfiles must match the institutions in the second column of the
institutions.csvfile. And that all CSV files must end with a blank line.
- Use this command, replacing
YOUR_DATA_DIRwith your new folder’s name. (Square brackets indicate optional arguments; if you use them, omit the square brackets. All of them relate to the name of your tournament.)
$ ./manage.py importtournament YOUR_DATA_DIR [--slug SLUG] [--short-name SHORT_NAME] [--name FULL_NAME]
This script has a number of options. They’re worth taking a look at before you run the script. For details, see:
$ ./manage.py importtournament --help
- Assuming the command completes successfully without errors, you should double check the data in the Django interface, as described above in Creating a tournament. In particular you should check that the Rounds have the correct draw types and that silent rounds have been marked correctly.
importtournament on Heroku installs¶
importtournament script can be run on Heroku directly; you just need to commit and push your new data directory to your server first. See Installing on Heroku for details. If you have a local installation ready, you might like to iron out all the errors in your data until you can import locally without error, before pushing your data files to your server to be imported there.
If you want to import locally and push the database to the server, you can use the
heroku pg:push command. We assume that, if you want to use this method, you know what you’re doing or are comfortable reading the Heroku documentation to find out. We’re happy to help if you have questions about this, but for most tournaments, committing the data to the server and running the script on the server directly will be easier.
Writing your own importer¶
If our suggested file formats cause you headaches, it might be easier to write your own importer. We have a generic importer framework that should make this easier, so for some tournaments it might (very conceivably) be faster to write your own importer to conform to your data, than it is to make your data conform to our importer. You need a background in Python in order to do this. For more details, see Tournament Data Importers.