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

安装

pip3 install autoliter
# 或者
pip install autoliter

软件参数

autoLiterature

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

使用

# 假设你要保存的pdf文件夹地址是 output = /home/cat/pdfs/
# 假设你要更新的笔记文件夹地址是 input = /home/cat/notes/
autoliter -i input -o output             # 更新input文件夹下所有md文件
autoliter -i input/example.md -o output  # 仅更新input/example.md文件

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

# -m 是个可选项,表示要迁移的PDF文件夹路径,当-m存在时,会重新链接笔记和pdf文件下的文件
autoliter -i input -m
autoliter -i input -o output -m
autoliter -i input -o output -d -m

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.1.tar.gz (10.8 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: autoliter-0.1.1.tar.gz
  • Upload date:
  • Size: 10.8 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.1.tar.gz
Algorithm Hash digest
SHA256 c378f38d3621bce283eb8d91b4f4165437ebe7f3951a5f53bc273111d7e4c163
MD5 bf922b6daaf8f3c93b5babbd25d840de
BLAKE2b-256 e77f41f5700e58d239b3d0db60173d626ab1b4c4f94e46a85e5262dcb5dcd1d4

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