Skip to main content

mad-search

Codeberg

Search OpenAlex for academic articles using YAML-frontmatter markdown files.

Requirements

Installation

# run directly with uv
uv run mad-search path/to/search.md

# or install globally
uv tool install mad-search

Usage

Create a markdown file with YAML frontmatter:

---
api_key: your_key_here
query: "(machine learning AND climate) OR large language models"
journals:
  - Nature
  - Science
year_from: 2020
year_to: 2025
---

Run it:

uv run mad-search search.md

Results are written to out/<input>.md (the input file is never modified — keeping your API key safe).

Features

  • Boolean searchAND, OR, NOT with parentheses, passed directly to OpenAlex's Elasticsearch backend
  • Journal filter — names auto-resolved to ISSNs via the OpenAlex Sources endpoint
  • Year range — optional year_from / year_to constraints
  • Result re-ranking — results scored by title match (40%), abstract match (20%), and concept overlap (40%) after retrieval
  • Structured output — summary table plus detail sections with DOI, citation count, FWCI, concepts (top 5, score ≥ 0.3), topics, and abstract
  • Idempotent — re-running overwrites out/<input>.md

Output

Results are written to out/<input>.md as a markdown table with detail sections:

## Results — 5 paper(s) found

| # | Title | DOI | Journal | Year | Citations | Authors |
|---|---|---|---|---|---|---|

---

### 1. Paper Title

- **DOI:** `10.xxx/...`
- **Authors:** ...
- **Journal:** ...
- **Citations:** 124 | FWCI: 3.2
- **Concepts:** Climate Science (0.92), Machine Learning (0.87)
- **Topics:** Machine Learning (0.99), Climate Science (0.85)
- **Abstract:** ...

License

MIT — see LICENSE.

Download files

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

Source Distribution

mad_search-0.1.4.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

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

mad_search-0.1.4-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file mad_search-0.1.4.tar.gz.

File metadata

  • Download URL: mad_search-0.1.4.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"43","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mad_search-0.1.4.tar.gz
Algorithm Hash digest
SHA256 781c23e1c08b254cff7a7f5ae62297d9c279716aac0102f437fc6388cc56fca0
MD5 77db827d2ec6c76724c8ea57545db918
BLAKE2b-256 340dc6766b504a03b1ba6a62d5f499942a7e54661294f262055baea6f7237a72

See more details on using hashes here.

File details

Details for the file mad_search-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: mad_search-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"43","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mad_search-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 89b6249dcfd9bfc17a042f875374abe7f2fc24e816f6789ce0970825d7208b7f
MD5 8b8518770ad4397273f04dbd56560267
BLAKE2b-256 93edf35b290b2d3fa05cb7f4ab461219d691c5acf302e9a5cb0e8d8627f1c71b

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

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