neuron-zk-generator/README.md
2024-11-14 13:17:26 +00:00

1,000 B

neuron-zk-generator

This Python application reads data from my zettelkasten and formats it so that it can be compiled as a Neuron project and from there published as a static-site on the Web.

Local development

source venv/bin/activate
pip install -r requirements.txt
neuron-zk-generator

Run as local application

pipx install [local_path_to_application]
neuron-zk-generator

Update after changes

pipx uninstall neuron-zk-generator
pipx install [local_path_to_application]

Build single executable

Use pyinstaller to create single executable file. pyinstaller is installed along with other packages in requirements.txt.

From root:

pyinstaller -F src/app.py
# -F compiles to single file

Outputs to neuron-zk-generator/dist/app.

Sourcing the executable:

/home/thomas/repos/neuron-zk-generator/dist/app