Skip to content

philipempl/ResearchyPi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ResearchyPi

Drawing Google Scholar Stats on RPI Waveshare

ResearchyPi in action

Prerequisites

Name Link Price
Raspberry Pi Zero WH Get it here $16
Waveshare 2.13 Display Hat Get it here $15

Getting started

Update and upgrade the RPI

sudo apt-get update
sudo apt-get upgrade

Install git and clone this repository

sudo apt-get install git
git clone https://github.com/philipempl/ResearchyPi.git
cd ./ResearchyPi

Install Python and its dependencies

sudo apt-get install libxslt-dev python3-pip python3-pil
sudo pip3 install RPi.GPIO scholarly

Enable SPI

To enable SPI, follow these steps:

sudo raspi-config

Then, navigate to "Interface Options" (Option 3) and enable SPI (I4).

Run the app

You can find the scholar identifier in the URL provided by Google Scholar after "user=" and ending with an ampersand.

python3 src/main.py Lu-BjV4AAAAJ

Update the stats continuously

To update and schedule your stats automatically, create a service file using systemd. For instance:

sudo nano /etc/systemd/system/update-stats.service

The service file itself, updating every 14400 seconds (4-hour interval), looks like this:

[Unit]
Description=ResearchyPi
After=multi-user.target

[Service]
Type=idle
User=pi
ExecStart=python3 /home/pi/ResearchyPi/main.py SCHOLAR_ID

Restart=always
RestartSec=14400

[Install]
WantedBy=multi-user.target

Then, grant rights to the user and enable the systemd file on startup by running the following commands:

sudo chmod 644 /etc/systemd/system/update-stats.service
sudo systemctl daemon-reload
sudo systemctl enable update-stats.service
sudo systemctl start update-stats.service

Contributing

If you'd like to contribute, have a look through existing Issues and Pull Requests that you could help with. If you would like to request a feature or report a bug, please create a GitHub Issue using one of the default templates.

Authors

License

This project is available under the MIT license.


Feel free to copy and paste this markdown into your GitHub README.md file, and it should create a visually appealing and well-structured README for your project. Make sure to replace `SCHOLAR_ID` with the actual scholar identifier where needed.