Skip to main content

Helps you manage your literature notes

Project description

autoLiterature

autoLiterature是一个基于Python的自动文献管理命令行工具。Inspired by Mu Li.

识别规则:

  • 自动识别 - {xxx}
  • 当笔记文件中包含- {paper_id}时候,会下载该文献的信息,不下载PDF
  • 当笔记文件中包含- {{paper_id}}时候,会下载该文献的信息,以及PDF。

注意:paper_id支持已发表文章的doi,预发布文章的arvix_id, biorvix_id, medrvix_id

安装

  1. pip 安装
pip install autoliter
或者
pip3 install autoliter
  1. 源码安装
git clone https://github.com/WilmerWang/autoLiterature.git
cd autoLiterature
python setup.py install 

软件参数

autolter

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        The path to the note file or note file folder.
  -o OUTPUT, --output OUTPUT
                        Folder path to save paper pdfs and iamges. NOTE: MUST BE FOLDER
  -p PROXY, --proxy PROXY
                        The proxy. e.g. 127.0.0.1:1080
  -d, --delete          Delete unreferenced attachments in notes. Use with caution,
                        when used, -i must be a folder path including all notes
  -m MIGRATION, --migration MIGRATION
                        the pdf folder path you want to reconnect to

使用

基本使用

假设input为文献笔记(md文件)的文件夹路径,output为要保存PDF的文件夹路径。

# 更新input文件夹下所有md文件
autoliter -i input -o output 

# 仅更新input/example.md文件
autoliter -i input/example.md -o output  

# -d 是个可选项,当 -i 是文件夹路径时候,使用 -d 会删除PDF文件夹下和文献笔记内容无关的pdf文件
autoliter -i input -o output -d

迁移笔记和PDF文件

当要移动文献笔记或者PDF文件夹的时候,文献笔记中的PDF链接可能会变的无法使用。可以使用-m来重新关联PDF文件和文献笔记。

# 更新input文件夹下所有md文件
autoliter -i input -m movedPDFs/

# 仅更新input/example.md文件
autoliter -i input/example.md -m movedPDFs/  

更多可以本地查看jupyter note,或者在线查看github doc文件夹。

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autoliter-0.1.3.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autoliter-0.1.3-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file autoliter-0.1.3.tar.gz.

File metadata

  • Download URL: autoliter-0.1.3.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for autoliter-0.1.3.tar.gz
Algorithm Hash digest
SHA256 ae52e757d19d07564404ecc98827912246d0617586f16ca78698e7e4e1cb8729
MD5 9b89cb735637650c024f081162f249e2
BLAKE2b-256 abd1b60be89dbcff9cf5567581152b842067ab2d76bd4304dc447091f27402a4

See more details on using hashes here.

File details

Details for the file autoliter-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: autoliter-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for autoliter-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2d8fe1ad28b3b8b235a60ace001629815dcb9f00e07ca5dd2806653eb0085c6a
MD5 d2d57bdce0359d0b29e453f3cf945e45
BLAKE2b-256 060f3eca224b608aa81410296b7e7b923cb605d63e4783abb5a05ebb7f8577b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page