Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/DavidMChan/ArXiV-Notify

ArXiV Notification Bot which sends you an email with the latest updates!
https://github.com/DavidMChan/ArXiV-Notify

Last synced: 3 months ago
JSON representation

ArXiV Notification Bot which sends you an email with the latest updates!

Awesome Lists containing this project

README 

        
# ArXiV-Notify



ArXiV Notify is a python 3 bot which is designed to allow you to get daily/weekly updates about papers on ArXiV.



# Setup and Installation



### 1. Clone this repository into a location of your choosing



We can clone the repository using: `git clone https://github.com/DavidMChan/ArXiV-Notify`



### 2. Install the dependencies



This library depends on the `requests` library for API calls, and the `anthropic` library for summarization. Install the dependencies with:



```bash

pip install -r requirements.txt

```



### 3. Setup a mailgun account



This project uses Mailgun as the mail-sending application of choice. The following steps will walk you through getting started with a simple sandbox mail account. For more complicated messaging, you can set it up to use a custom domain.

    

You can create an account for free at [https://www.mailgun.com/](https://www.mailgun.com/). Once you create an account, follow the below steps to configure your account:



1. After your account is created a Sandbox Server will be created for you. Note the sandbox server url in the success message you receive here. That will be relevant again in a minute.



![](http://wpninjas.com/wp-content/uploads/2015/10/Screen-Shot-2015-10-16-at-2.20.08-PM-800x202.png)



2. You should have by now received an email from Mailgun regarding account activation. Go to your email Inbox now and activate your account.

    

3. Now head to the Mailgun control panel for your sandbox domain by starting at the dashboard, clicking on the 'domains' page, then clicking on your 'sandbox' domain in the lower panel. This will take you to a page where you will have a 'Domain Information' Section with the API key, and the API Base URL. Copy these down. You will need both of these in the next configuration step. 



4. We're also going to set up our sandbox domain for sending email to your recipients. Until you link your own domain, you have to get confirmation from an email before sending to them. On the 'Domain Information' page, there is another box called 'Authorized Recipients'. Add your email by clicking on the 'Manage Authorized recipients' box, then by clicking 'Invite new recipient' on the next page. Type in your email (the one you're going to use to recieve the ArXiV bot emails', and hit 'Invite Recipient'. You're going to recieve a confirmation email at that address, go to that email Inbox now and click accept. Congrats! You've now set yourself up to recieve email.



(This tutorial is adapted from http://webcraft.tools/sending-email-with-mailgun/, which you may want to reference for further information)



### 4. Setup the Anthropic API



For summarization, we use Claude: https://docs.anthropic.com/claude/docs. Follow the instructions at that link to get an API key for Claude.



### 5. Setup the config file



We need to add some details to the configuration file. Open up the arxivnotify.cfg file, it'll look something like this:

```py

#### General Configuration

# How many days of worth of papers should the bot send you?

HISTORY_DAYS = 1



#### Mailgun configuration ####

# API Key, has the format "key-********************************"

MAILGUN_API_KEY = key-********************************

# The root for mailgun, has the format "https://api.mailgun.net/v3/XXXXXX"

MAILGUN_ROOT    = https://api.mailgun.net/v3/XXXXXX

# The mailgun from email, has the format "Person Name "

MAILGUN_FROM    = Person Name 

# Mailgun destination emails, have the form "[email protected]"

MAILGUN_TO      = [email protected]

MAILGUN_TO      = [email protected]



#### CLAUDE Configuration ####

# API Key for anthropic API: https://docs.anthropic.com/claude/reference/getting-started-with-the-api

CLAUDE_API_KEY = "********************************"



#### Keywords ####

# You can have as many as you like

KEYWORD = Monkey

KEYWORD = Bicycles

```



In the `MAILGUN_API_KEY` field put your API key that you got from mailgun. In the `MAILGUN_ROOT`, put that API Base URL. In the `MAILGUN_FROM`, feel free to put what you want, as long as it has the format "Name \". Put the emails that you set up as authorized recipients in the `MAILGUN_TO` key. We can handle sending to as many as you want! (though they'll all get the same email). You can then add as many `KEYWORD` fields as you like. These are the searches that will be made.



### 6. Setup a service to run the script



You can use whatever scheduler you like to run the script, but because we're big linux fans, we like using CRON. You can add a cron job for this script, `0 1 * * * python3 /path/to/arxivnotify.py`.



If you're on windows, try using the AT command: https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-2000-server/bb726974(v=technet.10)



### 7. You're Done!



Enjoy your new ArXiV bot! :D



## Using your own mail client



If you don't want to go through the setup process for mailgun, or you are averse to the service for any reason, you can replace the mailgun client with your own client. The arxivnotify.py file is well segmented, and generates a HTML string as output, which it then passes to a very simple mail sender. The string 'html_output' contains the HTML at the end of the file (before entering step 3), meaning that you can feel free to do whatever you like with this string! Write it to a file! Send it over TCP-IP. Whatever. Have fun!



# License



This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.



This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.



You should have received a copy of the GNU General Public License

along with this program.  If not, see .