academic file converter

中文

Convertisseur de fichiers académique

Importez facilement des publications et des cahiers de jupyter sur votre site Web ou votre livre à la forme de Markdown

Caractéristiques

• Importer des cahiers Jupyter comme articles de blog ou chapitres de livre
• Importer des publications (telles que des livres, des procédures de conférence et des revues ) de votre responsable de référence à votre site Web ou livre de marque
  • Exportez simplement un fichier bibtex de votre gestionnaire de référence, comme Zotero, et fournissez-le comme entrée à l'outil de convertisseur
• Compatible avec tous les générateurs de sites Web statiques tels que Next, Astro, Gatsby, Hugo, etc.
• Facile à utiliser - 100% Python, aucune dépendance à l'égard des logiciels complexes tels que Pandoc
• Automatiser les conversions de fichiers à l'aide d'une action github

Communauté

• Afficher la documentation ci-dessous
• Chat en direct avec la communauté sur Discord
• ? Twitter: @getResearchDev @georgeCushen #MadeWithacademic

❤️ Soutenir la recherche ouverte et open source

Nous sommes en mission pour favoriser des recherches ouvertes en développant des outils open source comme celui-ci.

Pour nous aider à développer ce logiciel open source de manière durable sous la licence MIT, nous demandons à toutes les personnes et entreprises qui l'utilisent pour aider à soutenir sa maintenance et son développement en cours via le parrainage et la contribution.

Soutenir le mouvement de recherche ouverte:

• ️ Star ce projet sur github
• ❤️ Devenez un sponsor GitHub et déverrouillez les avantages
• ☕️ Faire un café
• ? contribuer

Installation

Ouvrez votre terminal ou votre application d'invite de commande et entrez l'une des commandes d'installation ci-dessous.

Avec pipx

Pour l'installation la plus simple , installez avec PIPX:

 pipx install academic

PIPX installera automatiquement la version Python requise pour vous dans un environnement dédié.

Avec pip

Pour installer à l'aide de l'outil PIP du Python, assurez-vous que Python 3.11+ soit installé puis exécutez:

 pip3 install -U academic

Usage

Ouvrez votre ligne de commande ou votre application Terminal et utilisez la commande cd pour accéder au dossier contenant les fichiers que vous souhaitez convertir, par exemple:

 cd ~/Documents/my_website

Publications d'importation

Téléchargez les références de votre gestionnaire de référence, comme Zotero, au format Bibtex.

Disons que nous avons téléchargé nos publications dans un fichier nommé my_publications.bib dans le dossier du site Web, importons-les dans le content/publication/ dossier:

 academic import my_publications.bib content/publication/ --compact

Arguments facultatifs:

• --compact générer une marque minimale sans commentaires ni clés vides
• --overwrite écraser toutes les publications existantes dans le dossier de sortie
• --normalize les étiquettes normaliser en les convertissant en minuscules et en capitalisant la première lettre (par exemple "science" -> "science")
• --featured Flagire de ces publications en vedette (pour apparaître dans la section Publications en vedette de votre site Web)
• --verbose ou -v afficher des messages verbeux
• - Aide --help help

Importer un texte intégral et une image de couverture

Après avoir importé des publications, nous vous suggérons:

• Modifiez l'organisme Markdown de chaque publication pour ajouter le texte intégral directement à la page (si la publication est un accès ouvert), ou autrement, pour ajouter des notes supplémentaires pour chaque publication
• Ajoutez une image nommée featured dans le dossier de chaque publication pour représenter visuellement votre publication sur la page et pour partager sur les réseaux sociaux
• Ajoutez le PDF de publication à chaque dossier de publication (pour les publications ouvertes), pour permettre aux visiteurs de votre site Web de télécharger votre publication

En savoir plus dans les documents Hugo Blox.

Importer des articles de blog à partir de cahiers Jupyter

Disons que nous avons nos cahiers dans un dossier notebooks dans le dossier du site Web, importons-les dans le content/post/ dossier:

 academic import 'notebooks/*.ipynb' content/post/ --verbose

Arguments facultatifs:

• --overwrite écraser tous les articles de blog existants dans le dossier de sortie
• --verbose ou -v afficher des messages verbeux
• - Aide --help help

Contribuer

Vous souhaitez contribuer à la recherche open source et ouverte ?

Apprenez à contribuer au code sur GitHub.

Consultez les problèmes ouverts et apportez une demande de traction.

Pour le développement local, clonez ce référentiel et utilisez de la poésie pour installer et exécuter le convertisseur à l'aide des commandes suivantes:

 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

Lors de la préparation d'une contribution, effectuez les contrôles suivants et assurez-vous qu'ils passent tous:

• Lint: make lint
• Format: make format
• Test: make test
• TYPE CHECK: make type

Aidez la version bêta à tester la version dev

Vous pouvez aider à tester la dernière version de développement en installant la dernière branche main de GitHub:

 pip3 install -U git+https://github.com/GetRD/academic-file-converter.git

Licence

Copyright 2018-présent George Cushen.

Licencié sous la licence du MIT.