Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arunanshub/pynanoid
A tiny, secure, URL-friendly, unique string ID generator for Python, written in Rust.
https://github.com/arunanshub/pynanoid
nanoid pyo3 python rust
Last synced: 28 days ago
JSON representation
A tiny, secure, URL-friendly, unique string ID generator for Python, written in Rust.
- Host: GitHub
- URL: https://github.com/arunanshub/pynanoid
- Owner: arunanshub
- License: mit
- Created: 2024-08-23T19:22:36.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-10-17T01:56:53.000Z (30 days ago)
- Last Synced: 2024-10-17T11:54:18.407Z (30 days ago)
- Topics: nanoid, pyo3, python, rust
- Language: Python
- Homepage:
- Size: 159 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyNanoID
[](https://github.com/astral-sh/ruff)
[](https://github.com/arunanshub/pynanoid)
[](https://pypi.org/project/pynanoid)
[](https://pypi.org/project/pynanoid)
[](https://coveralls.io/github/arunanshub/pynanoid?branch=master)
[](https://github.com/arunanshub/pynanoid/actions/workflows/ci.yml)
A tiny, secure, URL-friendly, unique string ID generator for Python, written in
Rust.
- **Safe.** It uses hardware random generator. Can be used in clusters.
- **Fast.** 2-3 times faster than Python based generator.
- **Compact.** It uses a larger alphabet than UUID (`A-Za-z0-9_-`). So ID size
was reduced from 36 to 21 symbols.
## Installation
```bash
pip install pynanoid
```
## Usage
```python
from pynanoid import generate
print(generate())
# SxuPyeUFRnoWnNlwtLBvT
```
Symbols `-,.()` are not encoded in the URL. If used at the end of a link they
could be identified as a punctuation symbol.
The Rust based high-performance generator is used by default if available. You
can also use pure-Python based generator as shown [here](#force-use-pure-python-generator).
> [!NOTE]
> If Rust based implementation is not available, the pure-Python
> generator will be automatically used.
If you want to reduce ID length (and increase the probability of collisions),
you can pass the length as an argument.
```python
from pynanoid import generate
print(generate(size=10))
# WtYW30_vPi
```
Don’t forget to check the safety of your ID length in ID [collision probability
calculator](https://zelark.github.io/nano-id-cc/).
### Custom Alphabet or Length
If you want to change the ID's alphabet or length, you can pass the alphabet as
the first argument and the size as the second argument.
```python
from pynanoid import generate
print(generate("1234567890abcdef", 10))
# bced90bd56
```
Non-secure generator is also available.
```python
from pynanoid import non_secure_generate
print(non_secure_generate())
# JlJp1Od7zjlcrfIttk0JB
```
> [!WARNING]
> Non-secure generator uses `random.random` internally. Hence it is not
> recommended for generating tokens or secrets.
### Force Use Pure-Python Generator
If you want to use the pure-Python generator, you can use functions provided in
`pynanoid.nanoid`.
```python
from pynanoid.nanoid import generate, non_secure_generate
print(generate()) # wBM-LJLoliqnGTOf38Qf4
print(non_secure_generate()) # ekN1GQBxPNjKM3XFGVO8q
```
## Benchmarks
We benchmark using
[pytest-benchmark](https://pytest-benchmark.readthedocs.io/en/latest/). You can
find the benchmark script in the `tests/` directory.
You can run the benchmarks using the following command:
```sh
pytest tests/benchmark.py --benchmark-histogram=assets/benchmark.svg
```
## Credits
- Andrey Sitnik for [Nano ID](https://github.com/ai/nanoid).
- Paul Yuan ([@puyuan](https://github.com/puyuan)) for
[py-nanoid](https://github.com/puyuan/py-nanoid).