nik
General Information
nik is a simplistic, versatile implementation of the Zettelkasten note-taking method roughly based on the original Zettelkasten introduced by German sociologist and philosopher Niklas Luhmann. It is based on plain-text markup files and intends to not get into your way whenever possible. Think of it more like a useful companion that helps you to browse, navigate and visualize your text-based Zettelkasten.
Features
- Plain-text markup files (Markdown, Org-mode, AsciiDoc)
- HTML based web view of your Zettelkasten (using static site generator)
- LaTeX support for web view (using MathJax)
- GraphML export of your Zettelkasten
Installation
You can install nik from The Python Package Index (PyPI). To do this, run the following command:
pip install nik
Usage (CLI)
Initialize a directory as your Zettelkasten with nik init <PATH>. Following on you can either provide the path to the Zettelkasten directly (-d option) or use the environment variable ZETTELKASTEN_PATH to point to your Zettelkasten. To show some basic information about your Zettelkasten run nik status. You can always run nik --help to ask for help.
Usage (Python)
Did you know that nik is both a command-line tool and a Python library? This is how it works:
from nik import Zettelkasten
path = '~/Zettelkasten'
z = Zettelkasten(path)
# Let's perform a rescan of the Zettelkasten directory
z.scan()
# Print all files in the index
print(z.index.files)
Development
- Create and activate virtual environment: e.g.
mkvirtualenv -p /usr/bin/python nik - Install:
pip install -e . - Run:
python -m nik
Metadata
Release files for nik 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nik-0.1.0.tar.gz | 7.8 kB | Without provenance | Details for nik-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nik-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for nik-0.1.0-py3-none-any.whl |
Total release size: 28.8 kB
Release files / nik-0.1.0.tar.gz
| Download URL | nik-0.1.0.tar.gz |
|---|---|
| Size | 7.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b127cfb1d20398ef92fd850bcdf726723ddbd09b5dcc233edf7ef60e080c1987
|
|
BLAKE2b-256 checksum How to use checksums |
a568148ac1603ed4092a221e39f25d96e32aa5fa045daaa826bbeba983b0fd28
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
|
Release files / nik-0.1.0-py3-none-any.whl
| Download URL | nik-0.1.0-py3-none-any.whl |
|---|---|
| Size | 21.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a31a3d7197290a4159bbed03ab5fa520c565649ff464e699faf360b546c25bbf
|
|
BLAKE2b-256 checksum How to use checksums |
e6a15cd0dbfe4b68a89e60e1a27b29c88317e3f05129f1906beec1ebd77263cb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
|
Security for nik 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.