craig.oates
/
overhaul2024
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Code to help with the re-arranging of my life in 2024.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
114 Commits
1 Branch
0 Tags
2.3 MiB
 
 
Branch: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
overhaul2024/README.org

3.6 KiB
Raw Permalink Blame History

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 Org-Babel installed and configured within your Emacs setup. If you have no experience with Emacs, 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,

  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

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,

  ;; Activate at start of coding session...
  ;; Change path to where you have saved this repository.
  (pyvenv-activate "overhaul2024/venv")
  (pyvenv-mode)

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.