Welcome to Lab Student Survey documentation!
Lab Student Survey
Python package for lab student survey. A single command fetches the spreadsheet generated from Google Forms and uploads the analysis results to Google Drive.
Usage
Create
student-lab-survey
(or any name) project in Google Cloud Platform.Enable
Google Drive API
in Google Cloud Platform.Create a
Service Account
in Google Cloud Platform.Download the
Service Account
credentials as JSON in Google Cloud Platform and save it asservice-secrets.json
in the working directory or set it asGDRIVE_SERVICE_ACCOUNT
environment variable (via GitHub Secrets).Create
student-lab-survey
(or any name) folder in Google Drive.Add the
Service Account
email to thestudent-lab-survey
folder withEditor
permissions.Create a
Google Form
for the lab student survey. The second question should be the name of the supervisor.Create a
Google Sheet
in thestudent-lab-survey
folder from theGoogle Form
.Create
metadata.csv
andmetadata_group_name.csv
in the working directory orstudent-lab-survey
folder in Google Drive to specify the question groups. The former will be automatically generated in the working directory if it does not exist. The latter is optional.
Environment Variables
Set the
Google Sheet
ID asLAB_STUDENT_SURVEY_FILE_ID
environment variable (via GitHub Secrets).Set the
student-lab-survey
folder ID asLAB_STUDENT_SURVEY_FOLDER_ID
environment variable (via GitHub Secrets). (Optional.) If not set, the parent folder ID of theGoogle Sheet
will be used.(Set the
Service Account
credentials asGDRIVE_SERVICE_ACCOUNT
environment variable (via GitHub Secrets).)
Running commands
lss
Github Actions
name: Run lab-student-survey
on:
schedule:
# every day at 00:00 UTC
- cron: "0 0 * * *"
workflow_dispatch:
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install wkhtmltopdf
run: sudo apt-get install -y wkhtmltopdf
- name: Install and run lab-student-survey
run: pipx run lab-student-survey
env:
LAB_STUDENT_SURVEY_FILE_URL: ${{ secrets.LAB_STUDENT_SURVEY_FILE_URL }}
LAB_STUDENT_SURVEY_FOLDER_URL: ${{ secrets.LAB_STUDENT_SURVEY_FOLDER_URL }}
GDRIVE_SERVICE_SECRETS: ${{ secrets.GDRIVE_SERVICE_SECRETS }}
Installation
Install this via pip or pipx (or your favourite package manager):
pipx install lab-student-survey
Alternatives
As far as I could find, there is no repository on GitHub for this particular topic. Instead, you may want to check out the following alternative websites. However, as there are too few people in a lab, with the effect of diminishing anonymity, most of these websites do not seem to attract many reviews.
国内
理系研究室のクチコミサイト|OpenLab: 募集停止中, 投稿するとAmazonギフト券(100円)がもらえる, ほとんど情報なし(100程度?)
LabBase 研究室サーチ: 入力方法不明, 上よりも情報なし
海外
PI Review: 231 reviews (2021/09/21)
GradPI: 329 reviews (2023/09/21), Must have a .edu or .ac.uk domain email address to even view the site.
RMGA: 3 reviews? (2021/09/21)
ratemypi.com, qcist.com: リンク切れ
한국에너지공과대학교 에너지공학부 구근호 - 김박사넷: かなり多い(1000以上?)
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!