Skip to main content

License: GPL v3 PyPI - Downloads

ZenKat

ZenKat is a tool and library to enable using a set of plaintext files, especially markdown files, as a Zettelkasten knowledge base.

I've used a number of knowledge management tools including Obsidian, Notion, and Coda, and have found them all lacking and / or designed in a way that makes them act as a walled garden. ZenKat is an attempt to create a lightweight FOSS alternative for command-line users. As such it aims to have few dependencies while still providing decent features.

It's named this way because of my bad memory for German. I remembered ZEttelKAsTen as ZenKat (unclear where the N came from).

Recommended Setup

You can install directly from pip:

pip install zenkat

This also installs the zenkat convenience script.

To configure themes and create custom queries and formats, make a file at ~/.config/zenkat/config.toml.

If you'd like to run directly from source you can clone the repository and use development mode.

It's also worth installing Marksman LSP if you plan on working with plaintext files a lot. This should work with major CLI editors including Helix, Neovim, and Spacemacs, as well as KATE. I use Helix.

For viewing files as formatted you can use MD Fileserver with mdstart.

diff comes by default on the command line and can be extremely helpful when combining duplicate notes (which Obsidian's multiple vaults tend to lead to).

Features

  • Filter and sort through notes with powerful mapping syntax
  • Customisable output formats and color schemes
  • Supports markdown tags, and unpacks nested tags
  • Resolves internal links, both inbound and outbound
  • Loads YAML metadata headers in pages
  • Task tracking with beautiful formatting, filters, and extended syntax
  • Configuration using config.toml in your home folder: see default_config for options

Contents

Metadata

Release files for zenkat 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zenkat 0.1.1
File Size Uploaded
zenkat-0.1.1.tar.gz 24.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for zenkat 0.1.1
File Interpreter ABI Platform
zenkat-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 48.5 kB

Release files / zenkat-0.1.1.tar.gz

Download URL zenkat-0.1.1.tar.gz
Size 24.5 kB
Tags Source
SHA-256 checksum
How to use checksums
5576e09dd23a44395414cd76feeb3cc61d2d7fdf781874e67b5be96a81a4db7e
BLAKE2b-256 checksum
How to use checksums
fb4d2a0a3be24bc8769029106542431fc0c306fe9783e7476c6d81ba2b4e1db5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Release files / zenkat-0.1.1-py3-none-any.whl

Download URL zenkat-0.1.1-py3-none-any.whl
Size 24.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5a864cf3e0f9dfc70d58b34e03b2df6ef95971bc609c5ebcc8a958a4e4cd0704
BLAKE2b-256 checksum
How to use checksums
d1d7173f515fa8e24e3d9efa3e11ee058ca194dca4b94ea73b59be32308900c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page