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.4.0.tar.gz (3.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.4.0-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: randflake-1.4.0.tar.gz
  • Upload date:
  • Size: 3.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.4.0.tar.gz
Algorithm Hash digest
SHA256 68621005d1f349abcc9e7c491d5a76aa172d032e5fa99d3dd8a4a87fb899dc78
MD5 fb4589fc0281729dbf32d87d99b44f74
BLAKE2b-256 0469e813c57558f754fa809fae7d735c3eb4842c0bfa54b8f47a2dac2c2e91da

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: randflake-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 4.1 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 04cc77d6daf8a512e11eddfa5e466a1368f44f3dad89920ea2b51d209af4f71a
MD5 032036514bc7a6a31de8c906726259c9
BLAKE2b-256 d6c530e006ef12b82eb371ffe450732048940b7d81ede2ccdca56956e9597556

See more details on using hashes here.

Provenance

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