Skip to main content

AI-Powered Research Paper Analysis and Management System

Project description

ArionXiv - AI-Powered Research Paper Analysis

ArionXiv is a CLI tool for discovering, analyzing, and managing research papers from arXiv with AI-powered insights.

Features

  • Smart Search: Find papers with intelligent relevance scoring
  • AI Analysis: Deep paper analysis using OpenRouter (FREE models available)
  • Daily Dose: Personalized daily paper recommendations
  • Chat with Papers: Ask questions about any paper
  • Personal Library: Organize your research collection
  • Beautiful CLI: Rich terminal interface with customizable themes
  • Trending: Discover trending research topics

Installation

Option 1: Using pipx (Recommended)

pipx automatically handles PATH configuration:

# Install pipx if you don't have it
pip install pipx
pipx ensurepath

# Install ArionXiv
pipx install arionxiv

Option 2: Using pip

pip install arionxiv

If arionxiv command is not found after installation, you need to add Python Scripts to your PATH:

Windows (PowerShell)

Run in PowerShell as Administrator:

$scriptsPath = python -c "import sysconfig; print(sysconfig.get_path('scripts'))"
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";$scriptsPath", "User")

Restart your terminal after running this command.

Windows (Command Prompt)

Run in Command Prompt as Administrator:

for /f "tokens=*" %i in ('python -c "import sysconfig; print(sysconfig.get_path('scripts'))"') do setx PATH "%PATH%;%i"

Restart your terminal after running this command.

macOS / Linux (Bash)
echo 'export PATH="$PATH:$(python3 -c "import sysconfig; print(sysconfig.get_path(\"scripts\"))")"' >> ~/.bashrc
source ~/.bashrc
macOS / Linux (Zsh)
echo 'export PATH="$PATH:$(python3 -c "import sysconfig; print(sysconfig.get_path(\"scripts\"))")"' >> ~/.zshrc
source ~/.zshrc

Quick Start

1. First Run Setup

On first run, ArionXiv will guide you through API key setup:

arionxiv

2. Required Setup

You need:

3. Basic Commands

# Search for papers
arionxiv search "transformer architecture"

# Fetch a paper
arionxiv fetch 2301.00001

# Analyze a paper with AI
arionxiv analyze 2301.00001

# Chat with a paper
arionxiv chat 2301.00001

# Get your daily dose
arionxiv daily

# See trending topics
arionxiv trending

# Manage settings
arionxiv settings

Alternative: Replace arionxiv with python -m arionxiv if the command is not found.

4. Authentication

# Register a new account
arionxiv register

# Login
arionxiv login

# Check session
arionxiv session

Configuration

Environment Variables

Set these in your .env file or system environment:

Variable Required Description
MONGODB_URI ✅ Yes MongoDB connection string
OPENROUTER_API_KEY ✅ Yes OpenRouter API key (FREE tier available)
JWT_SECRET_KEY ✅ Yes Secret key for authentication
GEMINI_API_KEY Optional Google Gemini for embeddings
GROQ_API_KEY Optional Groq as fallback LLM

Getting API Keys

  1. MongoDB Atlas (Free):

  2. OpenRouter (Free):

  3. JWT Secret:

    • Generate a secure random string (32+ characters)

Daily Dose Automation

Using GitHub Actions (Recommended)

ArionXiv can automatically deliver your daily paper recommendations:

  1. Fork the repository
  2. Add these secrets in Settings > Secrets:
    • MONGODB_URI
    • OPENROUTER_API_KEY
    • JWT_SECRET_KEY
  3. Configure your schedule:
    arionxiv settings daily
    

The workflow runs hourly and processes users based on their scheduled time.

Manual Daily Dose

# Run daily dose now
arionxiv daily --run

# View today's papers
arionxiv daily --view

Settings & Customization

# View all settings
arionxiv settings show

# Change theme color
arionxiv settings theme

# Configure API keys
arionxiv settings api

# Set research preferences
arionxiv settings prefs

# Configure daily dose
arionxiv settings daily

Optional Dependencies

# Advanced PDF processing (OCR, tables)
pip install arionxiv[advanced-pdf]

# ML features (local embeddings)
pip install arionxiv[ml]

# All extras
pip install arionxiv[all]

Commands Reference

Command Description
arionxiv search <query> Search for papers
arionxiv fetch <paper_id> Download a paper
arionxiv analyze <paper_id> AI analysis of paper
arionxiv chat [paper_id] Chat with papers
arionxiv daily Daily dose of papers
arionxiv trending Trending topics
arionxiv library Manage saved papers
arionxiv settings Configure ArionXiv
arionxiv login Login to account
arionxiv register Create account
arionxiv --help Show all commands

License

MIT License - see LICENSE for details.

Links


Built for researchers, by researchers 🔬

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arionxiv-1.0.3.tar.gz (166.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arionxiv-1.0.3-py3-none-any.whl (190.4 kB view details)

Uploaded Python 3

File details

Details for the file arionxiv-1.0.3.tar.gz.

File metadata

  • Download URL: arionxiv-1.0.3.tar.gz
  • Upload date:
  • Size: 166.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for arionxiv-1.0.3.tar.gz
Algorithm Hash digest
SHA256 c822e30206cb2d93f89e07f3c3cd5e514e03486e4460a5f0a54419a057645a7b
MD5 dca3d3c2f2bea83b8e4b92c799608ff7
BLAKE2b-256 b3b9560f8e5e7c4a6e613bf796d669eee0eba997274598398e5bb7b210a6c0dc

See more details on using hashes here.

File details

Details for the file arionxiv-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: arionxiv-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 190.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for arionxiv-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 353047b4de95bd2e76dfa6d9fc059a05b66475bdd0101518594b59e4d6af3fe0
MD5 4a076f632241f2849538ef8598f22146
BLAKE2b-256 ee3568977c6550948391d8622bd9100095b2b249d7a94893e09b4734807107aa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page