Skip to main content

Search OpenAlex for academic articles using YAML-frontmatter markdown files

Project description

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 appended to the same file, overwriting any previous results.

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), and abstract
  • Idempotent — re-running replaces the previous results section

Output

Results are appended 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)
- **Abstract:** ...

License

MIT — see LICENSE.

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

mad_search-0.1.0.tar.gz (16.7 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.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mad_search-0.1.0.tar.gz
  • Upload date:
  • Size: 16.7 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.0.tar.gz
Algorithm Hash digest
SHA256 a679182337645f07d6b3f65252a9130ad27473ecfdde4783afa46cba31e6d359
MD5 ee25eacb563111df6db3f2515f0c85c7
BLAKE2b-256 0784544389e03fd8ec6aab8d0a048a5e3be89676fc59ddacfbfa7391b1bf3d55

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mad_search-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.9 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 55752f7076f3ff2993f5679e20d325de877bdc5ed4d0a7f68007aa21cac38aef
MD5 cc692eea739b61a437acebcd2fc699e8
BLAKE2b-256 3c9baf1534c9710e6af64a723d57c000d7ec126f752364e70939cb165a3fba75

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