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

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.0.tar.gz (49.6 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.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: randflake-1.5.0.tar.gz
  • Upload date:
  • Size: 49.6 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.0.tar.gz
Algorithm Hash digest
SHA256 82c99482975756254dff16da562bc9c3648c9b5694cbf4a648fc7e159091c575
MD5 7b845775d165fc8d3355f5dce494ac71
BLAKE2b-256 91b327eeb3a2f8295682504cf263a221bd00a1fd5b9d73051b161862697f35c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for randflake-1.5.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: randflake-1.5.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a867d41156a7b94455f1b4c2e8949c7c103ebdfb8844e272fc2c5a3ca4bf1f2
MD5 d74229ce622c04e7ad86205622792dc2
BLAKE2b-256 df2077bcac112c3452e57b8e6073503c909b4cbf520a020c7cbbd2167cb6bb85

See more details on using hashes here.

Provenance

The following attestation bundles were made for randflake-1.5.0-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