academic file converter

中文

Conversor de arquivos acadêmicos

Importar facilmente publicações e notebooks Jupyter para o seu site ou livro formatado por marcação

Características

• Importar notebooks Jupyter como postagens de blog ou capítulos de livros
• Importar publicações (como livros, procedimentos de conferência e periódicos ) do seu gerente de referência para o seu site ou livro formatado por marcação
  • Basta exportar um arquivo bibtex do seu gerente de referência, como o Zotero, e fornecer isso como entrada para a ferramenta de conversor
• Compatível com todos os geradores de sites estáticos, como Next, Astro, Gatsby, Hugo, etc.
• Fácil de usar - 100% Python, sem dependência de software complexo, como Pandoc
• Automatizar conversões de arquivo usando uma ação do GitHub

Comunidade

• Veja a documentação abaixo
• Converse ao vivo com a comunidade em discórdia
• ? Twitter: @GetRearchDev @GeorGecushen #MadeWithacademic

❤️ Suporte de pesquisa aberta e código aberto

Estamos em uma missão para promover pesquisas abertas , desenvolvendo ferramentas de código aberto como essa.

Para nos ajudar a desenvolver esse software de código aberto de forma sustentável sob a licença do MIT, pedimos a todos os indivíduos e empresas que o usam para ajudar a apoiar sua manutenção e desenvolvimento contínuos por meio de patrocínio e contribuição.

Apoie o movimento de pesquisa aberta:

• ️ Estrela este projeto no github
• ❤️ Torne -se um patrocinador do GitHub e desbloqueie vantagens
• ☕️ doar um café
• ? ‍ Contribua

Instalação

Abra seu aplicativo de prompt de terminal ou comando e digite um dos comandos de instalação abaixo.

Com pipx

Para a instalação mais fácil , instale com PIPX:

 pipx install academic

O PIPX instalará automaticamente a versão Python necessária para você em um ambiente dedicado.

Com pip

Para instalar usando a ferramenta Pypon do Python, verifique se você possui o Python 3.11+ instalado e execute:

 pip3 install -U academic

Uso

Abra sua linha de comando ou aplicativo de terminal e use o comando cd para navegar até a pasta que contém os arquivos que você deseja converter, por exemplo:

 cd ~/Documents/my_website

Publicações de importação

Faça o download de referências do seu gerenciador de referência, como Zotero, no formato Bibtex.

Digamos que baixemos nossas publicações para um arquivo chamado my_publications.bib na pasta do site, vamos importá -los para o content/publication/ pasta:

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

Argumentos opcionais:

• --compact Gere uma marcação mínima sem comentários ou chaves vazias
• --overwrite substitui quaisquer publicações existentes na pasta de saída
• --normalize tags normalizadas convertendo -as em minúsculas e capitalizando a primeira letra (por exemplo, "ciência" -> "ciência")
• --featured base nessas publicações como destaque (para aparecer na seção de publicações em destaque do seu site)
• --verbose ou -v mostram mensagens detalhadas
• --help Ajuda

Importar texto completo e imagem de capa

Depois de importar publicações, sugerimos a você:

• Edite o corpo de marcação de cada publicação para adicionar o texto completo diretamente à página (se a publicação for acesso aberto) ou não, para adicionar notas suplementares para cada publicação
• Adicione uma imagem featured pasta de cada publicação para representar visualmente sua publicação na página e para compartilhar nas mídias sociais
• Adicione a publicação PDF a cada pasta de publicação (para publicações de acesso aberto), para permitir que os visitantes do seu site baixem sua publicação

Saiba mais nos documentos de Hugo Blox.

Importar postagens no blog de notebooks Jupyter

Digamos que temos nossos notebooks em uma pasta notebooks na pasta do site, vamos importá -los para o content/post/ pasta:

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

Argumentos opcionais:

• --overwrite substitui qualquer postagem de blog existente na pasta de saída
• --verbose ou -v mostram mensagens detalhadas
• --help Ajuda

Contribuir

Interessado em contribuir para o código aberto e a pesquisa aberta ?

Aprenda a contribuir com código no GitHub.

Confira os problemas abertos e contribua com uma solicitação de tração.

Para o desenvolvimento local, clone este repositório e use a poesia para instalar e executar o conversor usando os seguintes 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

Ao preparar uma contribuição, execute as seguintes verificações e verifique se todas elas passam:

• Identário: make lint
• Formato: make format
• Teste: make test
• Tipo Verificação: make type

Ajude a versão beta do desenvolvimento

Você pode ajudar a testar a versão mais recente de desenvolvimento instalando a última filial main do GitHub:

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

Licença

Copyright 2018-presente George Cushen.

Licenciado sob a licença do MIT.