nonebot-plugin-paper 0.1.0

build a world of open science.

NoneBot-Plugin-Paper

✨ NoneBot arXiv Paper Search Plugin ✨

📖 Introduction

NoneBot arXiv Paper search Plugin for arXiv APIs

Wiki: 👉 Portal

[!IMPORTANT] Star this project to receive all release notifications from GitHub without delay! ⭐️

💿 Installation

Choose one of the following methods

[!TIP] Multiple rendering methods are provided for paper information. By default, plaintext is used, which means no rendering, text-only output. In this case, the plugin requires no additional dependencies. Optional dependencies include playwright, skia, and pillow. Use nonebot-plugin-paper[skia] during installation to include required dependencies.

[Recommended] Install using nb-cli

Open command line in the Bot root directory and enter the following command

nb plugin install nonebot-plugin-paper

Install using package manager

pip install nonebot-plugin-paper
# or, use poetry
poetry add nonebot-plugin-paper
# or, use pdm
pdm add nonebot-plugin-paper

Open the configuration file in your NoneBot project root directory and append to the [plugin] section

plugins = ["nonebot_plugin_paper"]

⚙️ Configuration

For ArxivConfig settings, please refer to：👉 ArxivConfig Configuration

Config Item	Required	Default	Description
arxiv_paper_render	No	plaintext	Paper render type
arxiv_config	No	ArxivConfig()	Can be passed via nonebot.init(), config model will automatically read dotenv settings

🎉 Usage

[!note] Please check your COMMAND_START and the above configuration items. Default prefix is /

Command Tree

paper --search | -s [keyword]
                  --sort ['relevance', 'lastUpdatedDate', 'submittedDate']
                  --order ['ascending', 'descending']
                  --start [start]
      -id [paper_id]

Search by Keyword

/paper --search quantum computing

Search by Paper ID

/paper -id 2409.12922

💖 Acknowledgments

• Polyisoprene: Provided MVP implementation of skia rendering component
• HibiKier: Implemented command tree building for the plugin
• KomoriDev/Starify：Provided cool badges

Contributors

Thanks to these developers who contributed to this project:

📄 License

This project is open-sourced under the GPL-3.0 license