Skip to main content

Import ORCID publications into HugoBlox/Hugo publication bundles with DOI enrichment, PDF fetching, and cover generation.

Project description

HugoBlox ORCID Importer

CI License: MIT Python

Import publications from ORCID into HugoBlox/Hugo content/publications/ bundles, with optional Crossref DOI enrichment, PDF download, and cover image generation.

Features

  • imports ORCID works into Hugo leaf bundles
  • writes index.md and cite.bib
  • enriches DOI-based records from Crossref
  • downloads index.pdf when a reachable PDF is available
  • generates featured.png from the PDF
  • avoids orphan screenshots when no PDF could be fetched
  • includes optional HugoBlox template overrides for APA-style publication pages

Installation

Requires Python 3.10 or newer.

cd /path/to/hugobloxorcid
python -m pip install -e .[pdf]

If you only need the core importer:

python -m pip install -e .

Usage

Console entry point

hugoblox-orcid-import 0000-0003-1471-5827

Script wrapper

python scripts/orcid_import.py 0000-0003-1471-5827

Common options

# Rebuild all bundles and try to fetch PDFs
hugoblox-orcid-import 0000-0003-1471-5827 --force

# Regenerate one known slug
hugoblox-orcid-import 0000-0003-1471-5827 --only-slug 2025-mediendidaktik-als-implementierungswissenschaft-der --force

# Skip PDF fetching entirely
hugoblox-orcid-import 0000-0003-1471-5827 --no-download-pdf

Output

Each publication bundle may contain:

  • index.md
  • cite.bib
  • index.pdf when available
  • featured.png when generated from the PDF

featured.png is only kept when index.pdf exists.

Optional HugoBlox site overrides

Optional layout overrides are included under:

examples/hugo-site-overrides/

These can be copied into a HugoBlox site if you want the same APA-style citation rendering and publication metadata layout used during development.

Development

python -m pip install -e .[pdf]
python -m compileall src
python scripts/orcid_import.py --help
hugoblox-orcid-import --help

For maintainers, PyPI publishing is automated via .github/workflows/publish.yml using GitHub trusted publishing.

For contributions, see CONTRIBUTING.md.

Repository layout

src/hugobloxorcid/        Python package
scripts/orcid_import.py   Simple wrapper script
examples/                 Optional HugoBlox layout overrides
.github/workflows/        Basic CI for GitHub

License

MIT

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

hugobloxorcid-0.1.0.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

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

hugobloxorcid-0.1.0-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hugobloxorcid-0.1.0.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hugobloxorcid-0.1.0.tar.gz
Algorithm Hash digest
SHA256 15fc6e7f7b5a538989256a5ca3728983531bde17f0889a1a1b3e911cef07e496
MD5 389cba2b31e335c63b75853feae53be9
BLAKE2b-256 db34d53875e43214a5adaf1638c62f7bdfe7f3ca730babd335c624aacf1f6dd1

See more details on using hashes here.

Provenance

The following attestation bundles were made for hugobloxorcid-0.1.0.tar.gz:

Publisher: publish.yml on mkalz/hugobloxorcid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: hugobloxorcid-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hugobloxorcid-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 788a8f9acd69ae5e9badab836c303b4d2a2947c19335a75721331cf88e7c56e1
MD5 13ec5c8516b47708434486bd5c1e6790
BLAKE2b-256 b2b1911e62fdc82a8b09d72658d906896215342c994752324ba47a1ecce43d52

See more details on using hashes here.

Provenance

The following attestation bundles were made for hugobloxorcid-0.1.0-py3-none-any.whl:

Publisher: publish.yml on mkalz/hugobloxorcid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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