新闻稿网络可视化工具
zkviz的Python项目详细描述
zkviz:可视化zettels之间的链接网络(注释)
生成所有笔记及其连接的交互式概述。
安装
我建议使用python 3和专门用于zkviz的环境。
假设您使用的是MacOS或Linux,要创建环境,请打开 一个终端窗口并键入以下内容以创建独立环境 激活它。
python3 -m venv ~/envs/zkviz
source ~/envs/zkviz/bin/activate
然后使用以下命令安装zkviz:
pip install zkviz
如果您的计算机上安装了Graphviz, zkviz可以使用它绘制网络。它不是python包,因此需要 独立安装。如果你在Mac上 Homebrew安装后,可以从终端安装graphviz 使用:
brew install graphviz
用法
要从终端执行zkviz,您需要添加zkviz 环境变量的路径,或指定 zkviz可直接执行。下面,我使用显式路径。
在不带任何参数的情况下执行zkviz将基于
在当前目录中找到的*.md
文件。
~/envs/zkviz/bin/zkviz
您还可以将zkviz指向包含注释的文件夹。例如:
~/envs/zkviz/bin/zkviz --notes-dir ~/Notes
默认情况下,zkviz将查找扩展名为.md
的文件,但您可以重写
带有--pattern
选项的默认值:
~/envs/zkviz/bin/zkviz --pattern '*.mkdown'
也可以分别指定多个模式。以下是ZKVIZ 将查找所有TXT和MD文件。我建议用引号将图案括起来。
~/envs/zkviz/bin/zkviz --pattern '*.md' --pattern '*.txt'
您还可以将文件列表传递给zkviz:
~/envs/zkviz/bin/zkviz "~/Notes/201906021303 the state of affairs.md""~/Notes/201901021232 Journey to the center of the earth.md"
要使用graphviz生成可视化,请添加--use-graphviz
选项:
~/envs/zkviz/bin/zkviz --notes-dir ~/Notes --use-graphviz
默认情况下,zkviz将为文件中找到的每个引用绘制一个节点
提供,即使引用ZETTEL不存在,即使ZETTEL
指的是它自己。你可以用两种方式改变这种行为。这个--only-list
选项告诉zkviz只绘制提供给它的zettels的链接。
在下面的示例中,只显示两个zettel之间的链接:
~/envs/zkviz/bin/zkviz --only-list "20190810190224 Note 1.md""20190810190230 Note 2.md"
另一种改变行为的方法是使用
--no-self-ref
选项。
将zkviz与键盘大师一起使用
keyboard-maestro
文件夹包含一个Keyboard Maestro
基于文件列表自动创建可视化的宏
当前在The Archive中选定。到
使用这个宏,下载并导入键盘大师。跟随
在宏中设置必要变量的自述注释。
发布
- 在
zkviz/__init__.py
- 更新变更日志,链接版本。
- 提交并标记版本号
- 使用
python setup.py clean && rm dist/* && python setup.py sdist
构建源dist
- 使用
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
将测试上载到pypi测试
- 创建临时环境
mktmpenv
,并使用pip install --index-url https://test.pypi.org/simple/ zkviz
测试安装
- 如果一切看起来都很好,请使用
twine upload dist/*