Skip to main content

Import publications from your reference manager to Hugo

Project description

Hugo Academic CLI

Download from PyPI Download from Anaconda License

📚 Import publications from your reference manager to Hugo

Features

  • Import publications, including books, conference proceedings and journals, from your reference manager to your static site generator
    • Simply export a BibTeX file from your reference manager, such as Zotero, and provide this as the input
  • Hugo command pass-through

Community

❤️ Support this open-source software

To help us develop this Academic CLI tool and the associated Wowchemy software sustainably under the MIT license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship and contributing.

Support development of the Academic CLI:

Prerequisites

  1. Create a Hugo website such as by using the Hugo Academic Starter template for the Wowchemy website builder
  2. Download your site from GitHub, installing Hugo and its dependencies
  3. Install Python 3.6+ if it’s not already installed
  4. Version control your website
    • Ideally, version control your site with Git so that you can review the proposed changes and accept or reject them without risking breaking your site
    • Otherwise, if not using Git, backup your site folder prior to running this tool

Installation

Open your Terminal or Command Prompt app and install the Academic CLI tool:

pip3 install -U academic

Usage

Use the cd command to navigate to your website folder in the terminal:

cd <MY_WEBSITE_FOLDER>

Help:

academic

Import publications:

academic import --bibtex my_publications.bib

Optional arguments:

  • --help Help
  • --featured Flag publications as featured (to appear in Featured Publications widget)
  • --overwrite Overwrite existing publications
  • --publication-dir PUBLICATION_DIR Path to your publications directory (defaults to publication)
  • --normalize Normalize tags by converting them to lowercase and capitalizing the first letter
  • --verbose or -v Show verbose messages

After importing publications, a full text PDF and image can be associated with each item and further details added via extra parameters.

Run a Hugo command (pass-through):

academic server

Contribute

For local development, clone this repository and use Pipenv to install the tool using the following commands:

git clone https://github.com/wowchemy/hugo-academic-cli.git
cd hugo-academic-cli
pip3 install pipenv
pipenv install -e .

Preparing a contribution:

  • Lint: make lint
  • Format: make format
  • Test: make test

License

Copyright 2018-present George Cushen.

Licensed under the MIT License.

Analytics

Project details


Download files

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

Files for academic, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size academic-0.7.0-py3-none-any.whl (12.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size academic-0.7.0.tar.gz (13.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page