Django NATS Nkey is a Django app to synchronize Django superusers, accounts, and users with NATS nkey-based authentization/authorization scheme
Project description
Django Nats NKEYS
NATS is an infrastructure platform for building message-based services.
This Django app integrates NAT's multi-tenant account paradigm with Django Organizations.
The NATS nsc tool is used to manage operator, account, and user JWTs.
Quick start
-
pip install django-nats-nkeys[drf] -
Add to your INSTALLED_APPS settings:
INSTALLED_APPS = [ ... "organizations", "django_extensions", "django_nats_nkey", ] -
Run
python manage.py migrateto create the NATS organizationals models -
Run
python manage.py nsc-init(optional) Initialize a new NATS operator. You are responsible for copying the generated.conffile to your NATS server. If you choose to use an existing operator, you are responsible for runningnsc pullas a pre-deployment step.
Contributor's Guide
-
Create a development environment (requires docker & docker-compose):
make docker-up make nsc-init -
Run tests and generate a coverage report:
make pytest -
Run
blacklinter:make lint
Settings
Basic Settings
NATS_NSC_DATA_DIR (default: "/var/lib/nats/nsc/stores" or $NSC_STORE environment var)
NATS_NSC_CONFIG_DIR(default: "/var/lib/nats/nsc/config" or $NSC_HOME environment var)
NATS_NSC_KEYSTORE_DIR (default: "/var/lib/nats/nsc/keys" or $NKEYS_PATH environment var)
NATS_SERVER_URI (default: "nats://nats:4222")
NATS_NKEYS_IMPORT_DIR (default: ".nats/", )
NATS_NKEYS_EXPORT_DIR (default: ".nats/")
NATS_NKEYS_OPERATOR_NAME (default: "DjangoOperator")
Organization Models
- Based on Django organizations
- An
Organizationrepresents anaccountin NATS multi-tenant account model - An
Apprepresents auserin NATS multi-tenant account model
NATS_ORGANIZATION_MODEL (default: "django_nats_nkeys.NatsOrganization")
- Must subclass
django_nats_nkeys.models.NatsOrganization
NATS_ORGANIZATION_OWNER_MODEL (default: "django_nats_nkeys.NatsOrganizationOwner")
- Must subclass
django_nats_nkey.models.NatsOrganizationOwner
NATS_ORGANIZATION_APP_MODEL (default: "django_nats_nkey.NatsOrganizationApp")
- Must subclass
django_nats_nkey.models.AbstractNatsApp
NATS_ORGANIZATION_USER_MODEL (default: "django_nats_nkeys.models.NatsOrganizationUser")
- Must subclass
django_nats_nkeys.models.NatsOrganizationUser
Robot/Automation Models
NATS_ROBOT_APP_MODEL (default: "django_nats_nkeys.NatsRobotApp")
NATS_ROBOT_ACCOUNT_MODEL (default: "django_nats_nkeys.NatsRobotAccount")
App Models
NATS_APP_MODELS (default: [ "django_nats_nkey.NatsOrganizationApp" , "django_nats_nkeys.NatsRobotApp" ])
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django_nats_nkeys-0.7.1.tar.gz.
File metadata
- Download URL: django_nats_nkeys-0.7.1.tar.gz
- Upload date:
- Size: 18.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce86a734e2239d4b38a60e7606dd2538b763ae6e7da123c9bf394d8907c15773 |
|
| MD5 | 13652a9f6d7774822b539a15fdb3bb2c |
|
| BLAKE2b-256 | be5cbe9816114724a220cf661e52fbd39eab6fc40185a0995419f376b439a01d |
File details
Details for the file django_nats_nkeys-0.7.1-py3-none-any.whl.
File metadata
- Download URL: django_nats_nkeys-0.7.1-py3-none-any.whl
- Upload date:
- Size: 38.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f59aaebb6fe8b54b20c1b680a8f3db3b28ca7ca7cd4ef8d3f4aa9674865b3e10 |
|
| MD5 | 3d1c3b2ee7da1128bfef1f3c77af4a4d |
|
| BLAKE2b-256 | 71bc5c264f991f247492e3cb44de99412744746d818ff32cab42792315c6f386 |
