Package: vizel
See the stats and connections of your Zettelkasten.Getting StartedRequired Zettelkasten structureVizel tries to be format agnostic without requiring configuration.Vizel makes the following assumptions:The Zettel files have an.mdor.txtextension.All Zettel are in one single directory.References use the[[REFERENCE]]or[LABEL](REFERENCE)format.References of a Zettel pointing to itself are ignored.Vizel was first developed for the format used by theThe Archive. Other formats are
now supported as well, thanks to the help from the community.InstallingRunpip install vizelIf you get an error about missing graphviz when running thegraph-pdfcommand, you might need to install it withbrew install graphvizon OS X orsudo apt-get install graphvizon Ubuntu.Usagevizelhas the following commands:graph-pdfvizel 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.statsUsage: 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.A note on connected componentsThe fewer connected components your Zettelkasten has, the better. The
ideal number is 1. It means that you can reach any Zettel by following
links. This, in turn, should increase the likelihood of making new
semantic connections.Connected components are a concept from graph theory. In the context of
a Zettelkasten and vizel, a connected component is a set of Zettel,
which can be reached from any other Zettel in the same component by
following links. Those links do not need to be direct but can pass
through other Zettel. The direction of the links also doesn't matter.Two Zettel are not in the same component if there is no way to reach one
from the other through links.Connected components will show up as separate clusters of Zettel when
usinggraph-pdf. Use thecomponentscommand to get a list of your
components, and the Zettel contained in each.unconnectedUsage: 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.componentsUsage: vizel components [OPTIONS] DIRECTORY

  Lists the connected components and their Zettel in DIRECTORY.

Options:
  --help  Show this message and exit.Built WithNetworkX: Network analysis in Pythonclick: Python composable
command-line interface toolkitGraphviz: Simple Python interface
for GraphvizUpdates & ContributingFeel free to open issues and pull-requests. Subscribe to thevizel newsletterto be informed about
new releases and features in development.You can reach out to me for feedback or questions onTwitteror throughmy website.If you've found vizel useful, please considersponsoringmaintenance and
further development. Orbuying me a coffee.Development installThe project usesPoetry.Install Poetry.Clone this repository.Runpoetry installin the root of this project.Running testsRunpy.testin thetestsdirectory.VersioningVizel usesSemVerfor versioning. For the versions
available, see thetags on the repository.AuthorsBasil Philipp-OwnerLicenseThis project is licensed under GNU GPLv3.AcknowledgmentsThank you Christian Tietze and Sascha Fast for creatingThe Archiveapp and writing abook(German only) on the
Zettelkasten method.