Installing the Tools

ZettelGeist is a Python application and library. It can be installed from PyPI.

Requirements

We support Unix/Linux platforms only. This includes, but is not limited to:

• Linux/BSD systems
• OS X using Homebrew
• Windows using Windows Subsystem for Linux.

The minimum Python version is 3.10.

You must have sqlite3 with full-text search. Most built-in versions of sqlite3 have this, including the version distributed with OS X Homebrew.

We encourage and assume that you use a virtual environment (venv) for installing anything Python-related. See Creation of virtual environments.

Installation for general users

1. Create a virtual environment for running ZettelGeist:

   $ python3 -m venv ~/zenv

   You may install your environment wherever you like. We will assume ~/zenv.

2. Source the virtual environment

   $ . ~/zenv/bin/activate

   The prompt will now be prefixed by (zenv), the environment created in (1). The command deactivate returns you to the system environment.

3. Confirm that you are picking up the right python and pip.

   (zenv) $ which pip
   /path/to/zenv/bin/pip
   (zenv) $ which python
   /path/to/zenv/bin/python

   In place of path/to/ you should see the absolute path to the environment created in (1).

4. Install ZettelGeist

   (zenv) $ pip install zettelgeist
   Collecting zettelgeist
     Downloading zettelgeist-0.12.2-py3-none-any.whl
   Collecting tatsu (from zettelgeist)
     Using cached TatSu-4.2.5-py2.py3-none-any.whl
   Collecting PyYAML (from zettelgeist)
   Installing collected packages: tatsu, PyYAML, zettelgeist
   Successfully installed PyYAML-3.12 tatsu-4.2.5 zettelgeist-0.12.2

   If you see zettelgeist-<version> in the output, you should have a successful install.

5. Verify the installation

   (zenv) $ which zcreate
   /path/to/zenv/bin/zcreate
   (zenv) $ which zimport
   /path/to/zenv/bin/zimport
   (zenv) $ which zfind
   /path/to/zenv/bin/zfind
   (zenv) $ which zfilter
   /path/to/zenv/bin/zfilter
   (zenv) $ which zettel
   /path/to/zenv/bin/zettel

   You may now proceed to the Manual.

Installation for developer-users

1. Create a virtual environment for running ZettelGeist:

   $ python3 -m venv ~/zenv

   You may install your environment wherever you like. We will assume ~/zenv.

2. Source the virtual environment

   $ . ~/zenv/bin/activate

   The prompt will now be prefixed by (zenv), the environment created in (1). The command deactivate returns you to the system environment.

3. Confirm that you are picking up the right python and pip.

   (zenv) $ which pip
   /path/to/zenv/bin/pip
   (zenv) $ which python
   /path/to/zenv/bin/python

   In place of path/to/ you should see the absolute path to the environment created in (1).

4. Clone the Repository

$ git clone https://github.com/ZettelGeist/zettelgeist

4. Install ZettelGeist. From the ZettelGeist source directory run

$ python -m pip install .

5. Verify the installation

   (zenv) $ which zcreate
   /path/to/zenv/bin/zcreate
   (zenv) $ which zimport
   /path/to/zenv/bin/zimport
   (zenv) $ which zfind
   /path/to/zenv/bin/zfind
   (zenv) $ which zfilter
   /path/to/zenv/bin/zfilter
   (zenv) $ which zettel
   /path/to/zenv/bin/zettel