academic file converter
v0.11.2
中文
特征
社区
我们的使命是通过开发这样的开源工具来促进开放研究。
为了帮助我们在MIT许可下可持续地开发此开源软件，我们要求所有使用它来帮助其持续维护和开发的个人和企业通过赞助和贡献。
支持开放研究运动：
打开您的终端或命令提示应用程序，然后输入以下安装命令之一。
对于最简单的安装，请使用PIPX安装：
pipx install academic
PIPX将在专用环境中自动为您安装所需的Python版本。
要使用Python的PIP工具安装，请确保已安装Python 3.11+，然后运行：
pip3 install -U academic
打开您的命令行或终端应用程序，然后使用cd命令导航到包含您要转换的文件的文件夹，例如：
cd ~/Documents/my_website
以Bibtex格式从您的参考管理器（例如Zotero）下载引用。
假设我们将列为列表下载到网站文件夹中名为my_publications.bib的文件中，让我们将其导入到content/publication/文件夹中：
academic import my_publications.bib content/publication/ --compact
可选参数：
--compact在没有评论或空键的情况下生成最小的降价--overwrite撰写输出文件夹中的任何现有出版物--normalize通过将标签转换为小写并大写的第一个字母（例如“科学” - >“ science”）来归一化标签。--featured旗帜的标志这些出版物的特色（将出现在您网站的特色出版物部分中）--verbose或-v显示详细消息--help帮助帮助进口出版物后，我们建议您：
featured的图像，以视觉上表示您在页面上的出版物并在社交媒体上共享在Hugo Blox文档中了解更多信息。
假设我们在网站文件夹中的notebooks文件夹中有笔记本，让我们将其导入到content/post/ folder中：
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 lintmake formatmake testmake type您可以通过安装GitHub的最新main分支来帮助测试最新的开发版本：
pip3 install -U git+https://github.com/GetRD/academic-file-converter.git
版权所有2018年至今的乔治·库森（George Cushen）。
根据MIT许可获得许可。
