Skip to content

internetarchive/arklet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Arklet - A basic ARK resolver

lint_python

What is an ARK?

See https://arks.org/

What is Arklet?

Arklet is a Python Django application for minting, binding, and resolving ARKs. It is intended to follow best practices set out by https://arks.org/.

Technical design notes:

  • Django is the only required dependency.
  • Supports each Django and Python version that is itself supported by the maintainers.
    • Tests are run against the upcoming versions of Python and Django as well.
  • This repo can be run as a standalone service
  • ...or the ark package can be installed as a reusable app in other Django projects.
  • Arklet is database agnostic.

Arklet is developed with uv, pytest, ruff, tox, and more.

Running Locally

Use the provided docker-compose.yml to spin-up a local Postgres.

uv run python manage.py migrate
uv run python manage.py createsuperuser
uv run python manage.py runserver

Running tests

uv run pytest .

First steps

Create your first NAAN, Key, and Shoulder in the admin: 127.0.0.1:8000/admin

And by the way, you now host a working ARK resolver! You can already try the following ones :

Happy minting, binding, and resolving!

Configuration Options

See arklet/entrypoints/settings.py for the full list of options to put in your config file.

About

ARK minter, binder, resolver

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages