academic file converter

中文

アカデミックファイルコンバーター

出版物やjupyterノートブックをマークダウンフォーマットのウェブサイトまたは本に簡単にインポートする

特徴

• jupyterノートブックをブログ投稿または本の章としてインポートします
• 参照マネージャーからマークダウンフォーマットのウェブサイトまたは本に出版物（本、会議の手続き、雑誌など）をインポートする
  • Zoteroなどのリファレンスマネージャーからbibtexファイルをエクスポートするだけで、これをコンバーターツールへの入力として提供します
• Next、Astro、Gatsby、Hugoなどのすべての静的Webサイトジェネレーターと互換性があります。
• 使いやすい-100％Python、Pandocなどの複雑なソフトウェアへの依存性はありません
• GitHubアクションを使用してファイル変換を自動化します

コミュニティ

• 以下のドキュメントをご覧ください
• Discordでコミュニティとライブでチャットします
• ？ Twitter：@getresearchdev @georgecushen #madewithacadem

openturny研究とオープンソースのオープンサポート

私たちは、このようなオープンソースツールを開発することにより、オープンな研究を促進することを使命としています。

MITライセンスの下でこのオープンソースソフトウェアを持続可能に開発するのを支援するために、スポンサーシップと貢献を通じて継続的なメンテナンスと開発をサポートするために、それを使用するすべての個人および企業に依頼します。

オープンな研究運動をサポートしてください：

• ♥このプロジェクトはGithubでスターを務めています
• GitHubスポンサーになり、特典を解除します
• ☕唱コーヒーを寄付します
• ？貢献する

インストール

ターミナルまたはコマンドプロンプトアプリを開き、以下のインストールコマンドのいずれかを入力します。

PIPXで

最も簡単なインストールについては、PIPXにインストールしてください。

 pipx install academic

PIPXは、専用の環境に必要なPythonバージョンを自動的にインストールします。

ピップ付き

PythonのPIPツールを使用してインストールするには、Python 3.11+がインストールされてから実行されていることを確認してください。

 pip3 install -U academic

使用法

コマンドラインまたはターミナルアプリを開き、 cdコマンドを使用して、変換するファイルを含むフォルダーに移動します。

 cd ~/Documents/my_website

出版物を輸入します

Zoteroなどの参照マネージャーからBibtex形式から参照をダウンロードします。

Webサイトフォルダー内のmy_publications.bibという名前のファイルに出版物をダウンロードしたとしましょう。 content/publication/フォルダーにインポートしましょう。

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

オプションの引数：

• --compactコメントや空のキーなしで最小限のマークダウンを生成します
• --overwrite出力フォルダー内の既存の出版物を上書きします
• --normalizeタグを小文字に変換して最初の文字を大文字に変換して正規化します（例：「科学」 - >「科学」）
• --featuredフラグこれらの出版物は、特集されています（あなたのウェブサイトの注目の出版物セクションに表示される）
• --verboseまたは-v冗長なメッセージを表示します
• --helpヘルプヘルプ

全文をインポートし、画像をカバーします

出版物を輸入した後、私たちはあなたを提案します：

• 各出版物のマークダウン本文を編集して、全文をページに直接追加する（出版物がオープンアクセスである場合）、またはそれ以外の場合は、各出版物の補足ノートを追加する
• 各出版物のフォルダーにfeatured名前の画像を追加して、ページ上の出版物を視覚的に表し、ソーシャルメディアで共有するために
• 出版物PDFを各出版物フォルダーに追加します（オープンアクセス出版物用）、ウェブサイトの訪問者が出版物をダウンロードできるようにします

詳細については、Hugo Blox Docsをご覧ください。

Jupyterノートブックからブログ投稿をインポートします

Webサイトフォルダー内のnotebooksフォルダーにノートブックがあるとします。 content/post/フォルダーにインポートしましょう。

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

オプションの引数：

• --overwrite出力フォルダー内の既存のブログ投稿を上書きする
• --verboseまたは-v冗長なメッセージを表示します
• --helpヘルプヘルプ

貢献する

オープンソースとオープンリサーチへの貢献に興味がありますか？

GitHubでコードを寄付する方法を学びます。

オープンな問題をチェックして、プルリクエストを提供してください。

ローカル開発については、このリポジトリをクローンし、詩を使用して、次のコマンドを使用してコンバーターをインストールおよび実行します。

 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

貢献を準備するときは、次のチェックを実行し、それらがすべて合格することを確認してください。

• 糸くず： make lint
• 形式： make format
• テスト： make test
• タイプチェック： make type

ベータ版のテストを手伝ってください

GitHubから最新のmainブランチをインストールすることにより、最新の開発バージョンをテストするのに役立ちます。

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

ライセンス

Copyright 2018-Present George Cushen。

MITライセンスに基づいてライセンスされています。