Skip to main content

CLI Tool for Zettelkasten Graph Visualization

Project description

ztkn

Quickstart

wget https://raw.githubusercontent.com/aerithnetzer/ztkn/refs/heads/main/install.sh
sudo chmod +x install.sh
sudo sh install.sh

What this thing does

Parses a directory of .md files, create a network graph of wikilinks using networkx and creates an interactive graph in web browser using pyvis and flask.

Motivation

Tools such as foam and amethyst create interactivate graphs but that are highly-integrated features that are difficult to use outside of their respective application ecosystems. This allows you to interact with your second brain, even if you are on neovim, emacs, or helix.

Installation

Clone repository to ~/ and set the src.py to your PATH.

How to use

ztkn ~/path/to/your/vault

TODOs

  • Add preview of text when hovering over a node
  • When double clicking on a node, open the node's file in a the system's preffered editor of markdown files
  • Add a search bar to search for nodes
  • Advanced metrics for the graph
    • Centrality of a given node
    • Betweenness of a given node(s)

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

ztkn-0.1.0-py3-none-any.whl (1.9 kB view details)

Uploaded Python 3

File details

Details for the file ztkn-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ztkn-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 1.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ztkn-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 527790e8b28ac622ab3d578de0342981e9517914815c9f980b3bdfda24c1f604
MD5 4ad784d7e4bc1ef4974a6a34b8005714
BLAKE2b-256 7ca58613be012bbdb4e90365b0173b43789da690c12e9a8ac6f35cbd0be43993

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