59 lines
1.1 KiB
Markdown
59 lines
1.1 KiB
Markdown
# Wallabag tools
|
|
|
|
Python tools using the Wallabag API.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install wallabag-tools
|
|
```
|
|
|
|
Or install in development mode:
|
|
|
|
```bash
|
|
uv pip install -e .
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Create a `config.ini` file with your Wallabag credentials:
|
|
|
|
```ini
|
|
[Wallabag Configuration]
|
|
host = https://your-wallabag-instance.com
|
|
grant_type = password
|
|
client_id = your_client_id
|
|
client_secret = your_client_secret
|
|
username = your_username
|
|
password = your_password
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Mass Import
|
|
|
|
Import articles from a JSON file:
|
|
|
|
```bash
|
|
uv run wallabag-mass-import --config config.ini --articles articles.json
|
|
```
|
|
|
|
Options:
|
|
- `--config`: Path to config file (default: config.ini)
|
|
- `--articles`: Path to articles JSON file (default: articles.json)
|
|
- `--max-entries`: Maximum number of entries to import (default: 0 = all)
|
|
- `--max-requests`: Maximum concurrent requests (default: 20)
|
|
- `--delete-after-import`: Delete entries after import
|
|
|
|
### Explorer
|
|
|
|
Browse entries in your Wallabag:
|
|
|
|
```bash
|
|
uv run wallabag-explorer --config config.ini --per-page 10
|
|
```
|
|
|
|
Options:
|
|
- `--config`: Path to config file (default: config.ini)
|
|
- `--per-page`: Entries per page (default: 10)
|