Metadata-Version: 2.4
Name: artui
Version: 1.0.0
Summary: A Terminal User Interface for browsing arXiv papers
Author-email: Florian Jonas <florian.jonas@cern.ch>
License: MIT
Project-URL: Homepage, https://github.com/fjonasALICE/arTui
Project-URL: Repository, https://github.com/fjonasALICE/arTui
Project-URL: Documentation, https://github.com/fjonasALICE/arTui#readme
Project-URL: Bug Tracker, https://github.com/fjonasALICE/arTui/issues
Keywords: arxiv,tui,research,papers,terminal,textual
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Terminals
Classifier: Topic :: Text Processing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: textual[syntax]>=0.41.0
Requires-Dist: arxiv>=2.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: requests>=2.25.0
Requires-Dist: pyperclip>=1.8.0
Requires-Dist: pygments>=2.10.0
Requires-Dist: pyinspirehep>=0.1.0
Provides-Extra: dev
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: isort>=5.10.0; extra == "dev"
Requires-Dist: flake8>=4.0.0; extra == "dev"
Requires-Dist: mypy>=0.950; extra == "dev"
Requires-Dist: pre-commit>=2.17.0; extra == "dev"
Dynamic: license-file

# ArTui - Stay up to date with recent ArXiv submissions!

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![Commits](https://img.shields.io/badge/commits-48-green.svg)](#)
[![Built with Textual](https://img.shields.io/badge/built%20with-Textual-purple.svg)](https://github.com/Textualize/textual)
[![arXiv](https://img.shields.io/badge/data%20source-arXiv-red.svg)](https://arxiv.org/)
[![INSPIRE-HEP](https://img.shields.io/badge/data%20source-INSPIRE--HEP-blue.svg)](https://inspirehep.net/)


A Terminal User Interface (TUI) application to stay up to date with recent arXiv submissions. Built with Python and Textual, featuring a persistent SQLite database. This tool was built with the help of AI to test AI capabilities and to build something useful for myself. The code is not pretty and I simply wanted to create a usable tool for myself.

**The main goal of the tool is to stay up to date with recent publications in your field**

# Disclaimer
This tool is not associated with arXiv and we thank arXiv for use of its open access interoperability. We also thank INSPIRE for providing their API free of charge for educational and informational use. The tool has been developed with the help of a mix of Claude Sonnet 4 and Gemini 2.5 Pro.
## Features
Stay up to date with recent publications in your field. New arXiv articles get fetched automatically according to predefined categories, and can be further filtered using custom filters. Read something you like? Save it for future reading right in your local PDF reader!

- **Smart Fetching**: Automatic background fetching of recent arXiv articles (last 7 days). Recent articles from selected categories and filters appear in your overview
- **Advanced Filtering**: Configure custom filters with category and text-based criteria
- **Reading Status**: Track viewed articles automatically
- **Persistent Database**: All articles stored locally in SQLite for fast offline access
- **Category Management**: Organize articles by arXiv categories (cs.AI, hep-th, etc.)
- **Tag Management**: Add custom tags to articles and filter by tags
- **Notes Management**: Create and edit markdown notes for articles
- **Citations Information**: Fetch and view BibTeX citations from Inspire-HEP & browse references and citations
- **Save System**: Save and organize your favorite articles
- **Modern TUI**: Beautiful, responsive terminal interface with mouse support
- **PDF Integration**: Download and open PDFs directly from the application
- **Full-Text Search**: Search across titles, authors, and abstracts

## Screenshots

![ArXiv Reader Screenshot](mainscreen.jpg)

*The ArXiv Reader interface showing the category sidebar, article list, and abstract panel*

![Notes Screenshot](notes.jpg)

*The Notes interface showing the markdown editor for taking notes on articles*

![Inspire information](inspire.jpg)

*The INSPIRE citation interface showing BibTeX citation information*

## How it works
- **Feed Configuration**: Categories and filters are configured in the YAML config file, which determines what articles appear in your personalized feed
- **Stay Current**: Browse articles from your feed to keep up with the latest publications in your field
- **Save for Later**: Mark articles you want to revisit by saving them to your Library using the "save" key
- **Automatic Cleanup**: Read articles in your feed are automatically removed after a retention period (default: 30 days) to keep your feed fresh
- **Permanent Library**: Saved articles remain in your library indefinitely and can be enhanced with custom tags and markdown notes
- **Global Discovery**: Search the entire arXiv database using "Global search" and add interesting articles directly to your library
- **Citation Network**: Explore the academic network by browsing papers that reference a given article or papers that cite it


## Installation

### Requirements
- Python 3.8+
- Internet connection for fetching articles

### Recommended: pipx (isolated, no venv management)

[pipx](https://pipx.pypa.io) installs CLI tools into their own isolated environment and makes them available system-wide — no manual virtual environment needed.

```bash
pipx install artui
```

To install pipx itself:
```bash
# macOS
brew install pipx && pipx ensurepath

# Linux / Windows (via pip)
pip install --user pipx && pipx ensurepath
```

### Alternative: pip

```bash
pip install artui
```

### From source (development)

```bash
git clone https://github.com/fjonasALICE/arTui
cd artui
pip install -e .
```

### Running the application

```bash
artui
```

**First time setup**: press `r` to fetch recent articles and populate the database.

## Configuration

### User Data Directory

ArTui stores all user data in a centralized location for better organization and portability:

**Default Location**: `~/.artui/`

**Directory Structure**:
```
~/.artui/
├── config.yaml          # Configuration file
├── arxiv_articles.db     # SQLite database
├── articles/             # Downloaded PDF files
└── notes/               # Article notes (markdown files)
```

### Custom User Data Directory

You can customize the user data directory location in several ways:

1. **Environment Variable**:
```bash
export ARTUI_DATA_DIR="/path/to/custom/directory"
artui
```

2. **Command Line Parameter**:
```bash
artui --user-dir "/path/to/custom/directory"
```

### User Directory Management

View user directory information:
```bash
artui userdir info
```

Migrate existing data from current directory:
```bash
artui userdir migrate
```

### Configuration File

Create or edit `config.yaml` in your user data directory to configure categories and filters:

```yaml
# Feed retention period in days - articles older than this are hidden from feed views unless unread
feed_retention_days: 30

categories:
  # Display Name: arXiv category code
  "Machine Learning": "cs.LG"
  "Artificial Intelligence": "cs.AI"
  "HEP Theory": "hep-th"
  "HEP Experiments": "hep-ex"
  "Quantum Physics": "quant-ph"

filters:
  # Custom filters with advanced criteria
  "ALICE Experiment":
    categories:
      - hep-ex
      - hep-ph
    query: "ALICE"
  
  "Deep Learning":
    categories:
      - cs.LG
      - cs.CV
    query: "deep learning OR neural network"
  
  "COVID Research":
    query: "COVID-19 OR coronavirus OR SARS-CoV-2"
```

## Usage

### Running the Application

```bash
artui
```

The application will:
1. Create the database file if it doesn't exist
2. Start the TUI interface
3. Automatically refresh articles (same as pressing 'r') - fetching recent articles (last 7 days)
4. Load the first configured category/filter automatically

### Key Bindings

| Key | Action |
|-----|--------|
| `s` | Save/Unsave the selected article |
| `u` | Mark article as unread |
| `o` | Download and open PDF |
| `i` | Show BibTeX citation from Inspire-HEP |
| `t` | Manage tags for the selected article |
| `n` | Create/edit notes for the selected article |
| `f` | Focus search box |
| `g` | Enable web search and focus search box |
| `c` | Show category/filter selection popup |
| `r` | Refresh and fetch new articles |
| `q` | Quit application |
| `Ctrl+d` | Toggle dark/light mode |
| `↑/↓` | Navigate article list |
| `Enter` | Select article (shows abstract) |
| `Mouse` | Click to navigate and select |

### Status Indicators

In the article list, the first column shows status:
- `●` - New/unread article
- ` ` (space) - Article has been viewed
- `s` - Article is saved/bookmarked
- `t` - Article has tags
- `n` - Article has note

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

Copyright 2025 Florian Jonas

## Support

For issues and feature requests, please use the GitHub issue tracker. 
## Dependencies

This project depends on the following Python packages:

- [textual](https://pypi.org/project/textual/) - `textual[syntax]>=0.41.0`
- [arxiv](https://pypi.org/project/arxiv/) - `arxiv>=2.0.0`
- [pyyaml](https://pypi.org/project/pyyaml/) - `pyyaml>=6.0`
- [requests](https://pypi.org/project/requests/) - `requests>=2.25.0`
- [pyperclip](https://pypi.org/project/pyperclip/) - `pyperclip>=1.8.0`
- [pygments](https://pypi.org/project/pygments/) - `pygments>=2.10.0`
- [pyinspirehep](https://pypi.org/project/pyinspirehep/) - `pyinspirehep>=0.1.0`
