Import Bibtex publications and Jupyter Notebook blog posts into your Markdown-formatted website or book.
Features
Community
We are on a mission to foster open research by developing open source tools like this.
To help us develop this open source 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 the open research movement:
Open your Terminal or Command Prompt app and enter one of the installation commands below.
For the easiest installation, install with Pipx:
pipx install academic
Pipx will automatically install the required Python version for you in a dedicated environment.
To install using the Python's Pip tool, ensure you have Python 3.11+ installed and then run:
pip3 install -U academic
Open your Command Line or Terminal app and use the cd command to navigate to the folder containing the files you wish to convert, for example:
cd ~/Documents/my_website
Download references from your reference manager, such as Zotero, in the Bibtex format.
Say we downloaded our publications to a file named my_publications.bib within the website folder, let's import them into the content/publication/ folder:
academic import my_publications.bib content/publication/ --compact
Optional arguments:
--compact Generate minimal markdown without comments or empty keys--overwrite Overwrite any existing publications in the output folder--normalize Normalize tags by converting them to lowercase and capitalizing the first letter (e.g. "sciEnCE" -> "Science")--featured Flag these publications as featured (to appear in your website's Featured Publications section)--verbose or -v Show verbose messages--help HelpAfter importing publications, we suggest you:
featured to each publication's folder to visually represent your publication on the page and for sharing on social mediaLearn more in the Hugo Blox Docs.
Say we have our notebooks in a notebooks folder within the website folder, let's import them into the content/post/ folder:
academic import 'notebooks/*.ipynb' content/post/ --verbose
Optional arguments:
--overwrite Overwrite any existing blog posts in the output folder--verbose or -v Show verbose messages--help HelpInterested in contributing to open source and open research?
Learn how to contribute code on Github.
Check out the open issues and contribute a Pull Request.
For local development, clone this repository and use Poetry to install and run the converter using the following commands:
git clone https://github.com/GetRD/academic-file-converter.git
cd academic-file-converter
poetry install
poetry run academic import tests/data/article.bib output/publication/ --overwrite --compact
poetry run academic import 'tests/data/**/*.ipynb' output/post/ --overwrite --verbose
When preparing a contribution, run the following checks and ensure that they all pass:
make lintmake formatmake testmake typeYou can help test the latest development version by installing the latest main branch from GitHub:
pip3 install -U git+https://github.com/GetRD/academic-file-converter.git
Copyright 2018-present George Cushen.
Licensed under the MIT License.
FAQs
Import Bibtex publications and Jupyter Notebook blog posts into your Markdown-formatted website or book.
We found that academic demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.