British House Price Data¶
A second project done as part of the Data CDT’s GEOG5995M/ENVS802 module: Programming For Social Scientists.
Contents: Intro. Discussion. UML. Tests. License. Documentation.
Intro¶
This assignment required that we develop a model, application, or analysis from scratch… In particular, the project had to:
- Read in some data.
- Process it in some way.
- Display the results.
- Write the results to a file.
For this project, my hope is that we will read in the Paid Price Data from HM Land Registry, write it to a SQLite database, and create a Flask web app that uses Leaflet to visualize a selection of that data on a map. This should be able to run anywhere by anyone with the code, but we’ll host it on PythonAnywhere; and then we’ll try and also have an API on the PythonAnywhere site so that we can also display the Leaflet frontend on a static site.
Discussion¶
Why are House Prices important? We could talk about the Housing Crisis and affordable housing…
Tests¶
Test-Driven Development [@Percival2017] requires that before actually doing anything, we run a test that will check whether what we want to do is done. We run the test before writing the desired feature, so that it fails (obviously), then we write the feature, and then the test should run successfully.
Documentation¶
This will be is automatically generated by Sphinx, which I learnt to use for the previous project. For this to work we have to make sure we write proper docstrings. We use Google style, which means we require the Napoleon extension for Sphinx.
Having generated it with Sphinx, we can also host the documentation freely at ReadTheDocs.org.
Contents: