An open API service indexing awesome lists of open source software.

https://github.com/datadavev/snark

Simply Normalizing ARKs
https://github.com/datadavev/snark

ark identifier

Last synced: about 1 year ago
JSON representation

Simply Normalizing ARKs

Awesome Lists containing this project

README

          

# SNARK

Simply Normal [ARK](https://datatracker.ietf.org/doc/html/draft-kunze-ark-27)s

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

![pytest workflow](https://github.com/datadavev/SNARK/actions/workflows/pytest.yaml/badge.svg)
[![CodeQL](https://github.com/datadavev/SNARK/workflows/CodeQL/badge.svg)](https://github.com/datadavev/SNARK/workflows?query=workflow%3ACodeQL)

## Installation

Snark can be installed locally using `pipx`, for example:

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

Snark will then be available from the command line:

```bash
$ 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:
```bash
$ snark -W
Snarking at http://localhost:20218/
```

## Development

SNARK uses [poetry](https://python-poetry.org/). To setup a development environment:

```bash
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.