Snakeflake is a discrete nonserial ID generator like Snowflake implemented in Python
Project description
Snakeflake
Snakeflake is a discrete nonserial ID generator like Snowflake and Sonyflake, implemented in Python.
"Discrete" and "nonserial" are real words. I promise.
Usage
>>> import datetime
>>> from snakeflake.snakeflake import SnakeflakeGenerator
>>> from snakeflake.config import SnakeflakeGeneratorConfig
>>>
>>> # Set the epoch to 5:30, 28 March 2010 and the machine ID to 283
>>> config = SnakeflakeGeneratorConfig(datetime.datetime(2010, 3, 28, 5, 30), 283)
>>> # Create the Snakeflake Generator
>>> sf = SnakeflakeGenerator(config)
>>> # Generate some Snakeflake IDs
>>> sf.next_id()
526063632593715483
>>> sf.next_id()
526063667423281435
>>> # Not specifying a Machine ID will generate one from your internal IP address
>>> config = SnakeflakeGeneratorConfig(datetime.datetime(2010, 3, 28, 5, 30), None)
>>> config.machine_id
1
Installation
You can install Snakeflake using pip:
pip install snakeflake
Documentation
View the documentation here.
To do:
- Better Documentation
- Add tests(!!!)
- Add a snakeflake decoder
- Publish (🎉🎉🎉)
-
Add an icon - Add a better icon
- Accept a function as a parameter to get the current machine id
- Accept a function as a parameter to check the uniqueness of the machine id
- Async support (if I decide to do the above)
Contributing
Want to contribute to this project? Feel free to submit a PR!
License
This project is licensed under the Apache 2.0 license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distributions
snakeflake-0.1.5.2-py3.7.egg
(12.8 kB
view hashes)
Close
Hashes for snakeflake-0.1.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 223cd399694b974dfd11de65328015b94cca06366e947b6caf72f80237fa9b0b |
|
MD5 | c11a22749d33630f1c961259d4bd2589 |
|
BLAKE2b-256 | 4114e9782fcf346d07a1eb9c6cde4cfefe9c4af03454643032869b6e68baa6c7 |