academic

v0.11.2

Import Bibtex publications and Jupyter Notebook blog posts into your Markdown-formatted website or book. For more information about how to use this package see README

Latest version published 1 year ago

License: MIT

PyPI

GitHub

Package Health Score

52 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

scholar
33

Popularity

Limited

GitHub Stars: 365
Forks: 103
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package academic, we found that it has been starred 365 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 26, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like academic is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 2
Open PR: 1
Last Release: 1 year ago
Last Commit: 11 months ago

Further analysis of the maintenance status of academic based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for academic is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: Yes

With more than 10 contributors for the academic repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like academic is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.11.5

Age: 6 years
Latest Release: 1 year ago
Dependencies: 4 Direct
Versions: 29
Maintainers: 0
Wheels: OS Independent

Readme

中文

Academic File Converter

📚 Easily import publications and Jupyter notebooks to your Markdown-formatted website or book

Features

Import Jupyter notebooks as blog posts or book chapters
Import publications (such as books, conference proceedings, and journals) from your reference manager to your Markdown-formatted website or book
- Simply export a BibTeX file from your reference manager, such as Zotero, and provide this as the input to the converter tool
Compatible with all static website generators such as Next, Astro, Gatsby, Hugo, etc.
Easy to use - 100% Python, no dependency on complex software such as Pandoc
Automate file conversions using a GitHub Action

Community

📚 View the documentation below
💬 Chat live with the community on Discord
🐦 Twitter: @GetResearchDev @GeorgeCushen #MadeWithAcademic

❤️ Support Open Research & Open Source

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:

⭐️ Star this project on GitHub
❤️ Become a GitHub Sponsor and unlock perks
☕️ Donate a coffee
👩‍💻 Contribute

Installation

Open your Terminal or Command Prompt app and enter one of the installation commands below.

With Pipx

For the easiest installation, install with Pipx:

pipx install academic

Pipx will automatically install the required Python version for you in a dedicated environment.

With Pip

To install using the Python's Pip tool, ensure you have Python 3.11+ installed and then run:

pip3 install -U academic

Usage

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

Import publications

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 Help

Import full text and cover image

After importing publications, we suggest you:

Edit the Markdown body of each publication to add the full text directly to the page (if the publication is open access), or otherwise, to add supplementary notes for each publication
Add an image named featured to each publication's folder to visually represent your publication on the page and for sharing on social media
Add the publication PDF to each publication folder (for open access publications), to enable your website visitors to download your publication

Learn more in the Hugo Blox Docs.

Import blog posts from Jupyter Notebooks

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 Help

Contribute

Interested 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:

Lint: make lint
Format: make format
Test: make test
Type check: make type

Help beta test the dev version

You 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

License

Licensed under the MIT License.

academic dependencies

bibtexparser nbconvert pyyaml ruamel-yaml

FAQs

What is academic?

Import Bibtex publications and Jupyter Notebook blog posts into your Markdown-formatted website or book. Visit Snyk Advisor to see a full health score report for academic, including popularity, security, maintenance & community analysis.

Is academic popular?

The python package academic receives a total of 995 weekly downloads. As such, academic popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is academic well maintained?

We found indications that academic is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is academic safe to use?

The python package academic was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 21:52 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Academic File Converter

📚 Easily import publications and Jupyter notebooks to your Markdown-formatted website or book

❤️ Support Open Research & Open Source

Installation

With Pipx

With Pip

Usage

Import publications

Import full text and cover image

Import blog posts from Jupyter Notebooks

Contribute

Help beta test the dev version

License

academic dependencies

FAQs

What is academic?

Is academic popular?

Is academic well maintained?

Is academic safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues