feat: show the popularity of 3rd-party content like Base Sets, AIs, G…

…Ses, and NewGRFs (#55)

.github/workflows/create-summary-quarter.yml

@@ -109,6 +109,23 @@ jobs:
           fi
         done
 
+    - name: Download BaNaNaS database
+      uses: actions/checkout@v4
+      with:
+        repository: OpenTTD/BaNaNaS
+        path: BaNaNaS
+
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Prepare environment
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
     - name: Run analysis
       shell: bash
       run: |

.github/workflows/create-summary-week.yml

@@ -113,6 +113,23 @@ jobs:
           rclone copy -v openttd:survey-packed-prod/${date_year}/${date_month}/openttd-survey-pack.${date}.tar.xz packed
         done
 
+    - name: Download BaNaNaS database
+      uses: actions/checkout@v4
+      with:
+        repository: OpenTTD/BaNaNaS
+        path: BaNaNaS
+
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Prepare environment
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
     - name: Run analysis
       shell: bash
       run: |

.gitignore

@@ -6,4 +6,5 @@ __pycache__/
 /.env/
 /_analysis/
 /_site/
+/BaNaNaS/
 /workers/node_modules/

README.md

@@ -12,7 +12,10 @@ This is a [Jekyll](https://jekyllrb.com/) website, and is served by nginx as a s
 
 To summarize survey results, the Python application `analysis` processes a bundle of JSONs and outputs another JSON with the summary.
 
-To run it, simply execute `python3 -m analysis <tar-xz bundle files>`
+To run it:
+- `git clone https://github.com/OpenTTD/BaNaNaS` to get the BaNaNaS dataset (needed to resolve NewGRFs).
+- Create a Python virtual env run `pip install -r requirements.txt`.
+- `python3 -m analysis <tar-xz bundle files>` to run the analysis.
 
 ### Running a local server