hrid


Namehrid JSON
Version 0.2.4 PyPI version JSON
download
home_pagehttps://github.com/hnimminh/human-readable-id
SummaryThe human readable id generator library for python3
upload_time2024-07-04 21:17:29
maintainerNone
docs_urlNone
authorMinh Minh
requires_python>=3.6.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
[![N|Solid](https://repository-images.githubusercontent.com/324334992/6016fe00-4882-11eb-8824-68c825521965)](https://github.com/hnimminh/human-readable-id)


<p  align="center">
  <strong>HRID: Human Readable Identifier</strong>
  <br>
  <code>The Human Readable ID Generator Library For Python3</code>
  <br>
</p>

## Usage

Install
```
pip3 install hrid
```

Use in Python code
```python
from hrid import HRID

hruuid = HRID()
uuid = hruuid.generate()
print(uuid)
```

## Why HRID ?
* Comaparing to UUID, hrid is extremely easy to remember, that why this package named `human readable`, example `red-bird-fly-crazily` versus `206dbaab-526b-41cd-aa6f-7febd82e83ab`. 
* Over 800 bilions alphabet hrid can be generated by default (or many more if include more factor to format). In the other hand, with a large numbers of ids, This library can guarentee that the uuid mostly not occur twice.
* Customizable structure for uuid, eg {`adj`}{`noun`} or {`number`}{`adj`}{`noun`}{`verb`}{`adverd`} or add whatever you want `prefix`, `postfix`

## Credit
* [Dictionary Source](https://github.com/dariusk/corpora)
* [Inspired by Google API Design](https://cloud.google.com/blog/products/gcp/api-design-choosing-between-names-and-identifiers-in-urls)

## License

[MIT](./LICENSE)



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hnimminh/human-readable-id",
    "name": "hrid",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6.0",
    "maintainer_email": null,
    "keywords": null,
    "author": "Minh Minh",
    "author_email": "hnimminh@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/ad/44/69d8e7cb93947655003a9a31d8d5cd838653f241d747289eb9786a586cc5/hrid-0.2.4.tar.gz",
    "platform": null,
    "description": "\n[![N|Solid](https://repository-images.githubusercontent.com/324334992/6016fe00-4882-11eb-8824-68c825521965)](https://github.com/hnimminh/human-readable-id)\n\n\n<p  align=\"center\">\n  <strong>HRID: Human Readable Identifier</strong>\n  <br>\n  <code>The Human Readable ID Generator Library For Python3</code>\n  <br>\n</p>\n\n## Usage\n\nInstall\n```\npip3 install hrid\n```\n\nUse in Python code\n```python\nfrom hrid import HRID\n\nhruuid = HRID()\nuuid = hruuid.generate()\nprint(uuid)\n```\n\n## Why HRID ?\n* Comaparing to UUID, hrid is extremely easy to remember, that why this package named `human readable`, example `red-bird-fly-crazily` versus `206dbaab-526b-41cd-aa6f-7febd82e83ab`. \n* Over 800 bilions alphabet hrid can be generated by default (or many more if include more factor to format). In the other hand, with a large numbers of ids, This library can guarentee that the uuid mostly not occur twice.\n* Customizable structure for uuid, eg {`adj`}{`noun`} or {`number`}{`adj`}{`noun`}{`verb`}{`adverd`} or add whatever you want `prefix`, `postfix`\n\n## Credit\n* [Dictionary Source](https://github.com/dariusk/corpora)\n* [Inspired by Google API Design](https://cloud.google.com/blog/products/gcp/api-design-choosing-between-names-and-identifiers-in-urls)\n\n## License\n\n[MIT](./LICENSE)\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "The human readable id generator library for python3",
    "version": "0.2.4",
    "project_urls": {
        "Homepage": "https://github.com/hnimminh/human-readable-id"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fe7ca58a1eedc19ea41262ff946cd9dc6f4e27fc430e204eaf87cd8acf4bff08",
                "md5": "48beae54b548cd156e9077f1a3f267c7",
                "sha256": "a86cdfd6952ae5b84362c3c508a387d4936d1cf58b15321dab4d65cb196539a6"
            },
            "downloads": -1,
            "filename": "hrid-0.2.4-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "48beae54b548cd156e9077f1a3f267c7",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.6.0",
            "size": 23072,
            "upload_time": "2024-07-04T21:17:27",
            "upload_time_iso_8601": "2024-07-04T21:17:27.405328Z",
            "url": "https://files.pythonhosted.org/packages/fe/7c/a58a1eedc19ea41262ff946cd9dc6f4e27fc430e204eaf87cd8acf4bff08/hrid-0.2.4-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ad4469d8e7cb93947655003a9a31d8d5cd838653f241d747289eb9786a586cc5",
                "md5": "c3df2634bbcac86de0485dae415a5790",
                "sha256": "9b2808d275c628e2f72ef09228a902ef1b1f28f7206bece528fda9b6db872020"
            },
            "downloads": -1,
            "filename": "hrid-0.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "c3df2634bbcac86de0485dae415a5790",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6.0",
            "size": 25447,
            "upload_time": "2024-07-04T21:17:29",
            "upload_time_iso_8601": "2024-07-04T21:17:29.425391Z",
            "url": "https://files.pythonhosted.org/packages/ad/44/69d8e7cb93947655003a9a31d8d5cd838653f241d747289eb9786a586cc5/hrid-0.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-04 21:17:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hnimminh",
    "github_project": "human-readable-id",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "hrid"
}
        
Elapsed time: 0.21807s