search

usgo / agagd

American Go Association Games Database (AGAGD)
https://agagd.usgo.org
MIT License
47 stars 30 forks source link

Update requirements and setup instructions #70

Closed annabunches closed 4 years ago

annabunches commented 4 years ago

Updated documentation to reflect dependence on an external DB schema that has drifted significantly from what syncdb produces.

Replaced MySQLdb with mysqlclient. The former is deprecated - it can no longer even be installed via 'pip'. Unfortunately, django 1.5.x relies on undocumented behavior that was not quite duplicated exactly in mysqlclient, which introduces a bug. Upgrading to Django 1.6.x fixes the resulting bug.

If upgrading to django 1.6 feels too risky, an alternative approach would be to download the MySQLdb module and check it in to git, and add instructions to install it locally. In general, however, I'd suggest that it is a good idea to start upgrading the django version - 1.5 has not been receiving security bugfixes since 2014. (the django docs recommend upgrading through one minor release at a time, so a larger jump is not advised)

The django 1.6 update DOES include backwards-incompatible changes, listed here: https://docs.djangoproject.com/en/3.0/releases/1.6/#backwards-incompatible-changes-in-1-6. As far as I've been able to determine, none of the breaking changes should apply to AGAGD, however, someone more familiar with the application should definitely verify that.

annabunches commented 4 years ago

Comments addressed. PTAL :)