academic file converter

中文

Convertidor de archivos académicos

Importar fácilmente publicaciones y cuadernos Jupyter a su sitio web o libro en forma de markdown

Características

• Importar cuadernos Jupyter como publicaciones de blog o capítulos de libros
• Publicaciones de importación (como libros, procedimientos de conferencia y revistas ) de su gerente de referencia a su sitio web o libro en forma de Markdown
  • Simplemente exporte un archivo bibtex desde su administrador de referencias, como Zotero, y proporcione esto como la entrada a la herramienta convertidor
• Compatible con todos los generadores de sitios web estáticos como Next, Astro, Gatsby, Hugo, etc.
• Fácil de usar : 100% Python, sin dependencia de software complejo como Pandoc
• Automatizar las conversiones de archivos utilizando una acción GitHub

Comunidad

• Ver la documentación a continuación
• Chatear en vivo con la comunidad en Discord
• ? Twitter: @getresearchdev @georgecushen #madewithacademic

❤️ Apoye la investigación abierta y el código abierto

Estamos en la misión de fomentar la investigación abierta mediante el desarrollo de herramientas de código abierto como esta.

Para ayudarnos a desarrollar este software de código abierto de manera sostenible bajo la licencia MIT, le pedimos a todas las personas y empresas que lo usan para ayudar a apoyar su mantenimiento y desarrollo continuos a través del patrocinio y la contribución.

Apoye el movimiento de investigación abierta:

• Mostr Estar este proyecto en Github
• ❤️ Conviértase en un patrocinador de Github y desbloquee ventajas
• ☕️ Done un café
• ? contribuir

Instalación

Abra su aplicación de Solicitud de terminal o del sistema e ingrese uno de los comandos de instalación a continuación.

Con pipx

Para la instalación más fácil , instale con PIPX:

 pipx install academic

PIPX instalará automáticamente la versión Python requerida para usted en un entorno dedicado.

Con Pip

Para instalar con la herramienta PIP de Python, asegúrese de tener instalado Python 3.11+ y luego ejecute:

 pip3 install -U academic

Uso

Abra su línea de comando o aplicación de terminal y use el comando cd para navegar a la carpeta que contiene los archivos que desea convertir, por ejemplo:

 cd ~/Documents/my_website

Publicaciones de importación

Descargue referencias de su administrador de referencias, como Zotero, en el formato Bibtex.

Digamos que descargamos nuestras publicaciones a un archivo llamado my_publications.bib dentro de la carpeta del sitio web, importémoslas en el content/publication/ carpeta:

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

Argumentos opcionales:

• --compact Genere una reducción mínima sin comentarios o claves vacías
• --overwrite sobrescribe cualquier publicación existente en la carpeta de salida
• --normalize las etiquetas Normalizar al convertirlas en minúsculas y capitalizar la primera letra (por ejemplo, "ciencia" -> "ciencia")
• --featured FAURDADA Estas publicaciones como se presentan (para aparecer en la sección Publicaciones destacadas de su sitio web)
• --verbose o -v mostrar mensajes detallados
• --help de Help

Importar texto completo e imagen de portada

Después de importar publicaciones, le sugerimos:

• Edite el cuerpo de Markdown de cada publicación para agregar el texto completo directamente a la página (si la publicación es de acceso abierto), o de otra manera, para agregar notas suplementarias para cada publicación
• Agregue una imagen featured en la carpeta de cada publicación para representar visualmente su publicación en la página y para compartir en las redes sociales
• Agregue la publicación PDF a cada carpeta de publicación (para publicaciones de acceso abierto), para permitir que los visitantes de su sitio web descarguen su publicación

Aprenda más en los documentos de Hugo Blox.

Importar publicaciones de blog de cuadernos Jupyter

Digamos que tenemos nuestros cuadernos en una carpeta notebooks dentro de la carpeta del sitio web, importémoslos en el content/post/ carpeta:

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

Argumentos opcionales:

• --overwrite sobrescribe cualquier publicación de blog existente en la carpeta de salida
• --verbose o -v mostrar mensajes detallados
• --help de Help

Contribuir

¿Interesado en contribuir al código abierto y a la investigación abierta ?

Aprenda a contribuir con código en GitHub.

Consulte los problemas abiertos y contribuya con una solicitud de extracción.

Para el desarrollo local, clone este repositorio y use poesía para instalar y ejecutar el convertidor utilizando los siguientes comandos:

 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

Al preparar una contribución, ejecute las siguientes comprobaciones y asegúrese de que todos pasen:

• Pelusa: make lint
• Formato: make format
• Prueba: make test
• Tipo de comprobación: make type

Ayuda Beta a probar la versión de desarrollo

Puede ayudar a probar la última versión de desarrollo instalando la última rama main de GitHub:

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

Licencia

Copyright 2018-presente George Cushen.

Licenciado bajo la licencia del MIT.