Skip to main content

A tiny, secure, URL-friendly, unique string ID generator support in Django

Project description

django-nanoid

A tiny, secure, URL-friendly, unique string ID generator for Python. support in Django.

PyPI Version PyPI Versions

Status

This project is actively maintained.

Installation

To install django-nanoid from pip:

    $ pip install django-nanoid

To install nanoid from source:

    $ git clone git@github.com:yosephbernandus/django-nanoid.git
    $ cd django-nanoid && python setup.py install

Usage

Adding a NANOID field to your Django models is straightforward, default length is 21. Can adjust the length using max_length

from django.db import models
from django_nanoid.models import NANOIDField

class Post(models.Model):
    id = NANOIDField(secure_generated=True, editable=False)

Passing this will automatically generate a unique identifier, with secure generated

from django.db import models
from django_nanoid.models import NANOIDField

class Post(models.Model):
    post_identifier = NANOIDField(size=10, alphabetically='mnhjksloiwnhA..!@$$$!#', secure_generated=False)

Passing this will automatically generate a unique identifier, with non_secure_generated with custom alphabetically and length

Contributing

If you would like to contribute, simply fork the repository, push your changes and send a pull request. Pull requests will be brought into the master branch via a rebase and fast-forward merge with the goal of having a linear branch history with no merge commits.

License

Apache 2.0

Dependencies

Changelog

Version 0.0.2 (2023-10-19)

  • Support nanoid prefix. Thanks lodye509!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-nanoid-0.0.2.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

django_nanoid-0.0.2-py3-none-any.whl (8.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page