Package: academic
中文Academic File Converter📚 Easily import publications and Jupyter notebooks to your Markdown-formatted website or bookFeaturesImport Jupyter notebooksas blog posts or book chaptersImport publications(such asbooks, conference proceedings, and journals) from your reference manager to your Markdown-formatted website or bookSimply export a BibTeX file from your reference manager, such asZotero, and provide this as the input to the converter toolCompatible with all static website generatorssuch as Next, Astro, Gatsby, Hugo, etc.Easy to use- 100% Python, no dependency on complex software such as PandocAutomatefile conversions using aGitHub ActionCommunity📚View thedocumentationbelow💬Chat live with thecommunityon Discord🐦 Twitter:@GetResearchDev@GeorgeCushen#MadeWithAcademic❤️ Support Open Research & Open SourceWe are on a mission to fosteropen researchby developingopen sourcetools 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:⭐️Starthis project on GitHub❤️Become aGitHub Sponsorandunlock perks☕️Donate a coffee👩‍💻ContributeInstallationOpen yourTerminalorCommand Promptapp and enter one of the installation commands below.With PipxFor theeasiestinstallation, install withPipx:pipx install academicPipx willautomatically install the required Python version for youin a dedicated environment.With PipTo install using the Python's Pip tool, ensure you havePython 3.11+installed and then run:pip3 install -U academicUsageOpen your Command Line or Terminal app and use thecdcommand to navigate to the folder containing the files you wish to convert, for example:cd ~/Documents/my_websiteImport publicationsDownload references from your reference manager, such as Zotero, in the Bibtex format.Say we downloaded our publications to a file namedmy_publications.bibwithin the website folder, let's import them into thecontent/publication/folder:academic import my_publications.bib content/publication/ --compactOptional arguments:--compactGenerate minimal markdown without comments or empty keys--overwriteOverwrite any existing publications in the output folder--normalizeNormalize tags by converting them to lowercase and capitalizing the first letter (e.g. "sciEnCE" -> "Science")--featuredFlag these publications asfeatured(to appear in your website'sFeatured Publicationssection)--verboseor-vShow verbose messages--helpHelpImport full text and cover imageAfter 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 publicationAdd an image namedfeaturedto each publication's folder to visually represent your publication on the page and for sharing on social mediaAdd the publication PDF to each publication folder (for open access publications), to enable your website visitors to download your publicationLearn more in the Hugo Blox Docs.Import blog posts from Jupyter NotebooksSay we have our notebooks in anotebooksfolder within the website folder, let's import them into thecontent/post/folder:academic import 'notebooks/*.ipynb' content/post/ --verboseOptional arguments:--overwriteOverwrite any existing blog posts in the output folder--verboseor-vShow verbose messages--helpHelpContributeInterested in contributing toopen sourceandopen research?Learnhow to contribute code on Github.Check out theopen issuesand contribute aPull 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 --verboseWhen preparing a contribution, run the following checks and ensure that they all pass:Lint:make lintFormat:make formatTest:make testType check:make typeHelp beta test the dev versionYou can help test the latest development version by installing the latestmainbranch from GitHub:pip3 install -U git+https://github.com/GetRD/academic-file-converter.gitLicenseCopyright 2018-presentGeorge Cushen.Licensed under theMIT License.