Git Product home page Git Product logo

arxivbot's Introduction

ArXiv Discord Bot

This Discord bot is designed to fetch new arXiv papers based on specified interests and share them in a designated channel. It utilizes the arXiv API to search for papers matching provided categories, authors, and keywords, then presents the results in the Discord server.

Installation

To run this bot, ensure the requirements are met by installing it:

pip install .

Setup

  1. Clone this repository to your local machine.

  2. Obtain a Discord bot token from the Discord Developer Portal.

  3. Create a .env file in the project directory and add your Discord bot token:

    DISCORD_TOKEN=your_discord_bot_token_here
    GUILD_ID=your_discord_guild_id_here
    CHANNEL_ID=your_discord_channel_id_here
    
  4. Customize the bot's interests by modifying the interests dictionary in the script.

  5. Adjust other configurations like MAX_NUMBER_OF_RESULTS and TIME if needed.

  6. Invite the bot to your Discord server using the OAuth2 URL generated from the Discord Developer Portal.

Usage

Run the bot using:

python -m arxivbot

Once the bot is set up and running, you can use the following commands:

  • !fetch: Fetches arXiv for new articles and prints them in the specified channel.
  • !abstract <num>: Prints the abstract of a fetched paper based on its number.
  • !query: Returns the registered queries.
  • !add_queries <cat> <keywords>: Adds keywords to the specified category (categories, authors, keywords).
  • !remove_queries <keyword>: Removes a parameter from the queries.
  • !clear_query: Removes all queries.
  • !max_results <num>: Changes the maximum number of results to fetch.

Note

  • The bot fetches papers daily at the specified time (TIME variable in the script).
  • Papers fetched will be from the current day if today is set to True.
  • Make sure to set up appropriate permissions for the bot in your Discord server.

arxivbot's People

Contributors

rodolfocarobene avatar

Stargazers

Pietro Campana avatar Juan Cereijo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.