Skip to content

Automatically receive the latest publications from your favorite authors or on your favorite topics conveniently by e-mail using the arXiv API.

License

Notifications You must be signed in to change notification settings

wimmerth/arxivscan

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

arxivscan

A simple script to get email notifications for new papers on arxiv.org.

Installation and Setup

  1. Clone the repository
git clone https://github.com/wimmerth/arxivscan.git
  1. Install the required packages:
conda create -n arxivscan python=3.9
conda activate arxivscan
python -m pip install --upgrade pip
pip install arxiv
  1. Create an app password for your gmail account (https://support.google.com/accounts/answer/185833?hl=en)
  2. Add your gmail address and app password as environment variables and reactivate the environment:
conda env config vars set ARXIVSCAN_EMAIL=<your gmail address>
conda env config vars set ARXIVSCAN_PASSWORD=<your app password (16 digits)>
conda deactivate
conda activate arxivscan
  1. Run the script:
python main.py

Optional arguments are:

  • --config: Path to the config file (default: config.json)
  • --interests: Lets you add interests to an existing config file in an interactive dialog
  • --on_startup: Set this flag if you want to automatically run this script (with a given config) on startup of the local machine
  1. If you want to run the script on startup, you can create a bash script with contents like this:
#!/bin/bash
source <absolute-path-to-conda>/etc/profile.d/conda.sh
conda activate arxivscan
python <absolute-path-to-this-directory>/main.py --config <path-to-your-config>.json --on_startup

and add it to your startup applications using crontab:

  1. Open crontab:
crontab -e
  1. Add the following line to the end of the file:
@reboot /bin/bash <absolute-path-to-your-bash-script>.sh

Example Mail Notification

img.png

About

Automatically receive the latest publications from your favorite authors or on your favorite topics conveniently by e-mail using the arXiv API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages