Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.11 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.11 KB

SNARK

Simply Normal ARKs

Note: 2021-08-08 Not yet released. The normalization rules are not verfiied and are subject to change.

pytest workflow CodeQL

Installation

Snark can be installed locally using pipx, for example:

pipx install git+https://github.com/datadavev/SNARK.git

Snark will then be available from the command line:

$ snark "https://example.org/ark:12345/x54xz321/s3/f8.05v.tiff"
ark:12345/x54xz321/s3/f8.05v.tiff

Snark has a local web UI as well:

$ snark -W
Snarking at http://localhost:20218/

Development

SNARK uses poetry. To setup a development environment:

git clone https://github.com/datadavev/SNARK.git
cd SNARK
mkvirtualenv SNARK
poetry install

The mkvirtualenv step is optional. Without it, poetry will make something for you.