Merge pull request #92 from hughrun/contributors

Contributors

.github/scripts/contributors.js

@@ -0,0 +1,31 @@
+const fs = require('fs')
+const cheerio = require('cheerio');
+const pretty = require('pretty');
+const page = fs.readFileSync('./website/sources/index.html', {encoding: 'utf-8' })
+var contributors = fs.readFileSync('./contributors.txt', {encoding: 'utf-8' }).split('\n')
+const $ = cheerio.load(page)
+var eventJson = JSON.parse(fs.readFileSync(process.env.GITHUB_EVENT_PATH, {encoding: 'utf-8' }));
+
+$('#contributors-list').empty() // remove all names to start clean
+for (let name of contributors) {
+  if (name.length > 0) {
+    for (let commit of eventJson.commits) {
+      // we only look for authors, not commiters, so we automatically ignore "actions-user"
+      if ( !contributors.includes(commit.author.name) ) {
+        contributors.push(commit.author.name)
+      }
+    } 
+    $('#contributors-list').append(`<li>${name}</li>\n`)
+  }
+}
+// write out new contributors.html file
+let newHtml = pretty($.html(), {ocd: true})
+fs.writeFileSync('./website/sources/index.html', newHtml, {encoding: 'utf-8'})
+// write out contributors.txt
+let newTxt = "";
+contributors.map( x => {
+  if (x) {
+    newTxt = newTxt.concat(`${x}\n`)
+  }
+})
+fs.writeFileSync('./contributors.txt', newTxt, {encoding: 'utf-8'})

.github/workflows/add-contributors.yml

@@ -0,0 +1,23 @@
+name: Add contributors
+
+on:
+  push:
+    branches: 
+      - "master"
+      - "main"
+
+jobs:
+  update-contributors:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Update text and html files
+      run: |
+        npm install cheerio
+        npm install pretty
+        node ./.github/scripts/contributors.js 
+
+    - uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: update contributors

.gitignore

@@ -1,2 +1,3 @@
 website/data/boundaries.geojson
-website/secrets.js
+website/secrets.js
+node_modules/*

README.md

@@ -16,6 +16,10 @@ See [sources](sources.md).
 
 See [contributing](contributing.md), especially *[which files to update](https://github.com/hughrun/public_library_map/blob/master/contributing.md#which-files-to-update)*.
 
+## Contributors
+
+Contributors (whether via GitHub or another way) are listed at [contributors.txt](contributors.txt).
+
 ## Licenses
 
 **/website/data**: [CC-BY-SA](https://creativecommons.org/licenses/by-sa/4.0/)

about.md

@@ -2,9 +2,12 @@
 
 This project collects and maps data from public libraries across the Australia and the external Australian Territories of Christmas Island and the Cocos (Keeling) Islands. In the long term I hope to include more data that can be combined and cross-referenced, e.g. library funding from local and state governments, HILDA data etc.
 
-You should be able to find the location of every public library in Australia territory, plus the standard loan period for each libary service, and whether they charge overdue fines (if known, in both cases).
+You should be able to find:
 
-Soon you will be able to see which integrated library system (ILS/LMS) each library service uses.
+* the location of every public library in Australia territory, plus 
+* the standard loan period for each libary service, and 
+* whether they charge overdue fines, and
+* which integrated library system (ILS/LMS) each library service uses
 
 ### Why this data?
 
@@ -53,9 +56,3 @@ If this naming convention is confusing, you may view the map in *Colonial mode*,
 * National & State Libraries
 
 Standard Mode invites you to think about the work these institutions do to normalise certain types of knowledge and not others.
-
-### Important file that is not in this repository
-
-The "core" geojson file with boundaries for each library service is not in the repository. The only other data it holds is the name of each area. When boundaries need to be changed for some reason (a regional library service de-merges, for example), this file needs to be updated using GQIS, and then processed into TopoJSON using `geo2topo`.
-
-This file isn't included in the GitHub repo for the simple reason that Git has a 100MB limit, and the file is larger than that. I could use Git-LFS but GitHub charges for moving large files around, and updating this file will rarely be necessary. If you want to access the geojson file you can find it at [librarymap.hugh.run/data/boundaries.geojson](https://librarymap.hugh.run/data/boundaries.geojson) \[105MB]. Contributors to this file are noted in [sources](sources.md).

contributors.txt

@@ -0,0 +1,4 @@
+Alissa M
+Paul Schulz
+Gareth Dixon
+Andrew Kelly

sources.md

@@ -4,6 +4,10 @@
 
 If you believe I have breached a license in using your data, or attributed it incorrectly, please get in touch at `librarymap`@`hugh`.`run`
 
+### Contributors
+
+See [contributors](contributors.txt).
+
 ### Visualisation
 
 | Source  | Link  | License |

website/about/index.html

@@ -29,8 +29,13 @@
       <section class="info-page">
         <h2 id="about-library-map">About Library Map</h2>
         <p>This project collects and maps data from public libraries across the Australia and the external Australian Territories of Christmas Island and the Cocos (Keeling) Islands. In the long term I hope to include more data that can be combined and cross-referenced, e.g. library funding from local and state governments, HILDA data etc.</p>
-        <p>You should be able to find the location of every public library in Australia territory, plus the standard loan period for each libary service, and whether they charge overdue fines (if known, in both cases).</p>
+        <p>You should be able to find:</p>
-        <p>Soon you will be able to see which integrated library system (ILS/LMS) each library service uses.</p>
+        <ul>
+          <li>the location of every public library in Australia territory, plus</li>
+          <li>the standard loan period for each libary service, and</li>
+          <li>whether they charge overdue fines, and</li>
+          <li>which integrated library system (ILS/LMS) each library service uses</li>
+        </ul>
         <h3 id="why-this-data">Why this data?</h3>
         <p>When I worked as a systems librarian in public libraries I often wondered how the social networks of decision makers - most obviously reflected by geography and state borders - affected decision making on things like library sofware procurement. I thought mapping systems visually might reveal things that are less obvious on a simple table or list.</p>
         <p>Rules about <strong>loan periods</strong> are arbitrary. I thought it might be interesting to see whether there are any regional trends. I’m surprised by some of the results — do some libraries really have a standard loan period of six weeks? Seems kind of long. Why do so many rural libraries only lend items for two weeks? Is it because country people read faster, or something to do with limited book stock? 🤔</p>

website/sources/index.html

@@ -30,6 +30,12 @@
         <h2 id="sources-attributions">Sources &amp; Attributions</h2>
         <p><em>Library Map</em> was written and conceived on unceded Wurundjeri Woi Wurrung land.</p>
         <p>If you believe I have breached a license in using your data, or attributed it incorrectly, please get in touch at <code>librarymap</code>@<code>hugh</code>.<code>run</code></p>
+        <h3 id="contributors">Contributors</h3>
+        <p>These people have contributed to making the map:</p>
+        <ul id="contributors-list">
+          <li>Alissa M</li>
+          <li>Paul Schulz</li>
+        </ul>
         <h3 id="visualisation">Visualisation</h3>
         <table>
         <thead>