Metadata-Version: 2.4
Name: arklet
Version: 0.2.1
Summary: An unassuming ARK minter, binder, and resolver
Project-URL: Repository, https://github.com/internetarchive/arklet
Author-email: Alex Dempsey <avdempsey@archive.org>
License: MIT License
        
        Copyright (c) 2025 Internet Archive
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.1
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.10
Requires-Dist: django<6.0,>=4.2
Provides-Extra: postgres
Requires-Dist: psycopg[binary]; extra == 'postgres'
Provides-Extra: sentry
Requires-Dist: sentry-sdk; extra == 'sentry'
Description-Content-Type: text/markdown

# Arklet - A basic ARK resolver

![lint_python](https://github.com/internetarchive/arklet/actions/workflows/lint_python.yml/badge.svg)


## 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 :
- [http://127.0.0.1:8000/ark:/13960/t5n960f7n](http://127.0.0.1:8000/ark:/13960/t5n960f7n)
- [http://127.0.0.1:8000/ark:/67375/C0X-SPWFRSGR-N](http://127.0.0.1:8000/ark:/67375/C0X-SPWFRSGR-N)
- [http://127.0.0.1:8000/ark:/12148/bpt6k65358454](http://127.0.0.1:8000/ark:/12148/bpt6k65358454)
- ...

Happy minting, binding, and resolving!

## Configuration Options

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