vizel 0.1.3

Vizualise a Zettelkasten

VIZEL

See the stats and connections of your Zettelkasten.

Getting Started

Required Zettelkasten structure

The following format is supported:

• The IDs of Zettel are 12 digit numbers (e.g. 202003302203).
• The Zettel files have an .md or .txt extension and the filename of each Zettel starts with an ID (e.g. 202003302203_This_is_an_example_Zettel.md).
• All of your Zettel are in one directory and not spread amongst multiple folders.

If you use The Archive, you should be fine.

Installing

Run pip install vizel

Usage

vizel has the following commands:

graph-pdf

vizel graph-pdf [OPTIONS] DIRECTORY

Generates a PDF displaying the graph created spanned by Zettel and their connections in the folder DIRECTORY.

Options:
  --pdf-name TEXT  Name of the PDF file the graph is written into. Default:
                   vizel_graph
  --help  Show this message and exit.

stats

Usage: vizel stats [OPTIONS] DIRECTORY

  Prints the stats of the graph spanned by Zettel in DIRECTORY.

  Stats calculated:
  - Number of Zettel
  - Number of references between Zettel (including bi-directional and duplicate)
  - Number of Zettel without any reference from or to a Zettel
  - Number of connected components
  
Options:
  --help  Show this message and exit.

unconnected

Usage: vizel unconnected [OPTIONS] DIRECTORY

  Prints all of the Zettel in DIRECTORY that have no in- or outgoing
  references.

Options:
  --help  Show this message and exit.

Built With

• NetworkX: Network analysis in Python
• click: Python composable command-line interface toolkit
• Graphviz: Simple Python interface for Graphviz

Contributing

Feel free to open issues and pull-requests.

You can reach out to me for feedback or questions on Twitter or through my website.

Development install

The project uses Poetry.

1. Install Poetry.
2. Clone this repository.
3. Run poetry install in the root of this project.

Running tests

Run py.test in the tests directory.

Versioning

This project uses SemVer for versioning. For the versions available, see the tags on the repository.

Authors

• Basil Philipp - Owner

License

This project is licensed under GNU GPLv3.

Acknowledgments

• Thank you Christian Tietze and Sascha Fast for creating The Archive app and writing a book (German only) on the Zettelkasten method.