adsfolio.cv

Public API for CV publication list generation.

class adsfolio.cv.CVConfig(query, orcid, use_orcid, debut_year, retire_year, exclude_bibstems, first_author_prefix, me_target, me_display, output_format, style, n_max_authors, n_min_authors, n_me, author_sep, me_fmt, author_format, markers, status, output_dir, output_filename, journal_legend, latex_list_env, latex_left_margin, latex_item_sep, template=<factory>)

Bases: object

Immutable runtime config for CV generation.

Parameters:

query (str)
orcid (str)
use_orcid (bool)
debut_year (int | None)
retire_year (int | None)
exclude_bibstems (tuple[str, ...])
first_author_prefix (str)
me_target (str)
me_display (str)
output_format (Literal['latex', 'markdown', 'template'])
style (str)
n_max_authors (int)
n_min_authors (int)
n_me (int)
author_sep (str)
me_fmt (str)
author_format (str)
markers (dict[str, adsfolio.cv.config.MarkerConfig])
status (dict[str, str])
output_dir (pathlib.Path)
output_filename (str)
journal_legend (bool)
latex_list_env (str)
latex_left_margin (str)
latex_item_sep (str)
template (adsfolio.cv.template.CVTemplate)

author_format: str

author_sep: str

debut_year: int | None

exclude_bibstems: tuple[str, ...]

first_author_prefix: str

journal_legend: bool

latex_item_sep: str

latex_left_margin: str

latex_list_env: str

markers: dict[str, adsfolio.cv.config.MarkerConfig]

me_display: str

me_fmt: str

me_target: str

n_max_authors: int

n_me: int

n_min_authors: int

orcid: str

output_dir: pathlib.Path

output_filename: str

output_format: Literal['latex', 'markdown', 'template']

property output_path: pathlib.Path: Path where generated output is written.

query: str

retire_year: int | None

status: dict[str, str]

style: str

template: adsfolio.cv.template.CVTemplate

use_orcid: bool

adsfolio.cv.generate_cv(client, cfg, *, output_path=None, output_format=None, style=None, write_output=True)[source]

Generate CV publication output and optionally write it to disk.

Parameters:

client (adsfolio.client.ADSClient)
cfg (adsfolio.cv.config.CVConfig)
output_path (pathlib.Path | None)
output_format (Literal['latex', 'markdown', 'template'] | None)
style (str | None)
write_output (bool)

Return type:

str

adsfolio.cv.load_config(path)

Load cv.yaml from disk.

Parameters:: path (pathlib.Path)
Return type:: adsfolio.cv.config.CVConfig

adsfolio.cv.render_cv(docs, cfg)[source]

Render already-fetched ADS documents without network access.

Parameters:

docs (list of dict) – ADS search documents with the fields in query.CV_FIELDS.
cfg (CVConfig) – Output format, style, template, and author settings.

Returns:

The rendered publication list.

Return type:

str