overhaul2024/README.org

* Overhaul 2024

Code to help with the re-arranging of my life in 2024. This is a messy data
science type repository, using a combination of literate programming (with
org-mode) and writing scripts in various programming languages. The most notable
being Bash, Python and Common Lisp (SBCL). One of the main goals with this
repository is to help establish a rough estimate of how much money I need to
make to live in a particular part of the United Kingdom. I'm kinda viewing it as
a 'show your working out' type of thing, like my maths exercise books from
school were laced with.

On a more technical note, this project is conducted from within Emacs, for the
most part. It, also, assumes you have [[https://orgmode.org/worg/org-contrib/babel/][Org-Babel]] installed and configured within
your Emacs setup. If you have no experience with [[https://www.gnu.org/software/emacs/][Emacs]], [[https://orgmode.org/][Org-Mode]] or Org-Babel,
feel free to work with any of the data files in the =raw-data/= and
=working-data/= directories (outside of Emacs).

* Quick Note: Python Virtual Environment

On your initial cloning of the repository, you will need to set up the virtual
environment for the Python code. To do that, run the following code,

#+begin_src shell :result silent
  cd <INSERT OVERHAUL2024 REPO. PATH HERE>
  python3 -m venv venv
  source venv/bin/activate
  pip install -r requirements.txt
  # If you don’t intend to run any Python code from the CLI, you can deactivate
  # the virtual environment.
  deactivate
#+end_src

There will be code blocks within some ORG files which do this, but that stuff
was entered whilst in the thick of it (initial set-up, quick test etc.) and can
be ignored for the most part. The code above is just to make it easier to get
going.

When working in ORG files, you will most likely see things like,

#+begin_src elisp :results silent
  ;; Activate at start of coding session...
  ;; Change path to where you have saved this repository.
  (pyvenv-activate "overhaul2024/venv")
  (pyvenv-mode)
#+end_src

This will need to execute these code blocks *before* executing Python code from
within that ORG file. This tells Emacs where the virtual environment is for this
project. Hopefully, I’ll have made it clear in each ORG file if you need to run
them or not.

* Data Sources [5/19]

Hopefully, I've managed to stay on top of the lists of websites I've used within
this repository. Having said that, I recommend you assume this list is not
exhaustive, or I’ve got around to working with that site’s data yet.

- [X] [[https://www.rightmove.co.uk][Right Move]]
- [X] [[https://www.spareroom.co.uk/][Spare Room]]
- [X] [[https://www.idealflatmate.co.uk/][Ideal Flatmate]]
- [X] [[https://www.onthemarket.com/][On The Market]]
- [X] [[https://www.roomies.co.uk/][Roomies]]
- +[ ] [[https://www.roomgo.co.uk/][Roomgo]]+ (Requires creating and account so don't intend to use this one)
- [ ] [[https://www.openrent.co.uk/][Open Rent]]
- [ ] [[https://www.zoopla.co.uk/][Zoopla]]
- [ ] [[https://www.primelocation.com/to-rent/][Prime Location]]
- [ ] [[https://rentright.co.uk/][Rent Right]]
- [ ] [[https://www.findahood.com/][Find a Hood]]
- [ ] [[https://www.gumtree.com/][Gum Tree]]
- [ ] [[https://www.onedome.com/][One Dome]]
- [ ] [[https://buildtorent.io/][Build to Rent]]
- [ ] [[https://www.nestoria.co.uk/][Nestoria]]
- [ ] [[https://property.mitula.co.uk/][Mitula]]
- [ ] [[https://nethouseprices.com/][Net House Prices]]
- [ ] [[https://homelet.co.uk/][Home Let]] (Provides the HomeLet Rental Index, more for comparing and
  monitoring average rent and changes over time)