Skip to main content

A Python implementation the Randflake ID: a distributed, uniform, unpredictable, unique random ID generator.

Project description

GitHub GitHub tag (latest SemVer) PYPI npm Go Reference

Randflake ID

Overview

Randflake ID is a distributed, uniform, unpredictable, and unique random ID generator designed to provide robust identifier generation across multiple programming languages and environments.

Key Features

  • 🌐 Multi-Language Support: Available in Go, Python, and TypeScript/JavaScript
  • 🔒 Cryptographically Secure: Generates unpredictable and unique identifiers
  • 🚀 High-Performance ID Generation: Optimized for lock-free operation to minimize latency and maximize throughput
  • 📈 Scalable: Engineered to handle high-throughput systems with a maximum ID generation rate of 17,179,869,184 ID/s
  • 🔀 Distributed-Friendly: Suitable for distributed systems and microservices
  • 📊 Uniform Distribution: Ensures even spread of generated IDs

Installation

Go

go get -u gosuda.org/randflake

Python

pip install randflake

TypeScript/JavaScript

npm install randflake

Usage Examples

Go

package main

import (
    "fmt"
    "time"

    "gosuda.org/randflake"
)

func main() {
    now := time.Now().Unix()

    nodeid := int64(42)
    lease_start := int64(now)
    lease_end := int64(now + 600)
    secret := []byte("super-secret-key")

    g, err := randflake.NewGenerator(nodeid, lease_start, lease_end, secret)
    if err != nil {
        panic(err)
    }

    id, err := g.Generate()
    if err != nil {
        panic(err)
    }
    fmt.Println(id)
}

Python

import time
from randflake import Generator

now = int(time.time())

nodeid = 42
lease_start = now
lease_end = now + 600
secret = b'super-secret-key'

g = Generator(nodeid, lease_start, lease_end, secret)

uid = g.generate()
print(uid)

TypeScript/JavaScript

import { Generator } from 'randflake';

const now = Math.floor(Date.now() / 1000);

const nodeid = 42;
const lease_start = now;
const lease_end = now + 600;
const secret = new TextEncoder().encode('super-secret-key');

const generator = new Generator(nodeid, lease_start, lease_end, secret);
const uid = generator.generate();
console.log(uid);

Performance

Randflake ID is designed for high-performance scenarios, with minimal overhead in ID generation.

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

More Information

For detailed documentation and additional resources, visit: https://gosuda.org/randflake

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

randflake-1.5.1.tar.gz (49.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

randflake-1.5.1-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file randflake-1.5.1.tar.gz.

File metadata

  • Download URL: randflake-1.5.1.tar.gz
  • Upload date:
  • Size: 49.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for randflake-1.5.1.tar.gz
Algorithm Hash digest
SHA256 817107e72c4bc7942cd85877f93dab65a2c0de2cff4899d5340711e33f0a4041
MD5 b2cfe0c9f035ebe986a2c5df72b8083b
BLAKE2b-256 c44b867b2f41b54af4e0b4b32e8e5a053589f9ecec95902f8736b32a69939649

See more details on using hashes here.

Provenance

The following attestation bundles were made for randflake-1.5.1.tar.gz:

Publisher: python-publish.yml on gosuda/randflake

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file randflake-1.5.1-py3-none-any.whl.

File metadata

  • Download URL: randflake-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for randflake-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ce8b169bc8739ab3272b4cf2bb10ee3113ecbe160fee10a985b7b1680ad3d7fb
MD5 db481918c3f11fa53baf7a6f9ef756aa
BLAKE2b-256 24f8ca5095fa38e68f77ed953dff55a09403d53973ca55c6b7a543af623f4383

See more details on using hashes here.

Provenance

The following attestation bundles were made for randflake-1.5.1-py3-none-any.whl:

Publisher: python-publish.yml on gosuda/randflake

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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