# Democritus Uuids
[](https://pypi.python.org/pypi/d8s-uuids)
[](https://github.com/democritus-project/d8s-uuids/actions)
[](https://github.com/democritus-project/d8s-uuids/actions)
[](https://codecov.io/gh/democritus-project/d8s-uuids)
[](https://semver.org/spec/v2.0.0.html)
[](https://github.com/psf/black)
[](https://choosealicense.com/licenses/lgpl-3.0/)
Democritus functions<sup>[1]</sup> for working with uuids.
[1] Democritus functions are <i>simple, effective, modular, well-tested, and well-documented</i> Python functions.
We use `d8s` (pronounced "dee-eights") as an abbreviation for `democritus` (you can read more about this [here](https://github.com/democritus-project/roadmap#what-is-d8s)).
## Installation
```
pip install d8s-uuids
```
## Usage
You import the library like:
```python
from d8s_uuids import *
```
Once imported, you can use any of the functions listed below.
## Functions
- ```python
def uuid4_examples(n: int = 10, *, uuids_as_strings: bool = True) -> Union[List[str], List[uuid.UUID]]:
"""Create n uuids."""
```
- ```python
def uuid4() -> str:
"""Create a random UUID."""
```
- ```python
def uuid3(name: str, *, namespace: Optional[uuid.UUID] = None) -> str:
"""Create a random uuid based on the given name."""
```
- ```python
def uuid5(name: str, *, namespace: Optional[uuid.UUID] = None) -> str:
"""Create a random uuid based on the given name."""
```
- ```python
def is_uuid(possible_uuid: Union[str, uuid.UUID], *, version: Optional[int] = None) -> bool:
"""Return whether or not the possible_uuid is a uuid."""
```
## Development
👋 If you want to get involved in this project, we have some short, helpful guides below:
- [contribute to this project 🥇][contributing]
- [test it 🧪][local-dev]
- [lint it 🧹][local-dev]
- [explore it 🔭][local-dev]
If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [Python project template](https://github.com/fhightower-templates/python-project-template).
[contributing]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#contributing-a-pr-
[local-dev]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#local-development-
Raw data
{
"_id": null,
"home_page": "https://github.com/democritus-project/d8s-uuids",
"name": "d8s-uuids",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,utility,uuids,uuid-utility,democritus",
"author": "Floyd Hightower",
"author_email": "floyd.hightower27@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c4/da/b10b5ce30cf9da9db1bbef89f3f320a4b94ad0ca4fa8aac81cc9cc84afa4/d8s_uuids-0.6.0.tar.gz",
"platform": "",
"description": "# Democritus Uuids\n\n[](https://pypi.python.org/pypi/d8s-uuids)\n[](https://github.com/democritus-project/d8s-uuids/actions)\n[](https://github.com/democritus-project/d8s-uuids/actions)\n[](https://codecov.io/gh/democritus-project/d8s-uuids)\n[](https://semver.org/spec/v2.0.0.html)\n[](https://github.com/psf/black)\n[](https://choosealicense.com/licenses/lgpl-3.0/)\n\nDemocritus functions<sup>[1]</sup> for working with uuids.\n\n[1] Democritus functions are <i>simple, effective, modular, well-tested, and well-documented</i> Python functions.\n\nWe use `d8s` (pronounced \"dee-eights\") as an abbreviation for `democritus` (you can read more about this [here](https://github.com/democritus-project/roadmap#what-is-d8s)).\n\n## Installation\n\n```\npip install d8s-uuids\n```\n\n## Usage\n\nYou import the library like:\n\n```python\nfrom d8s_uuids import *\n```\n\nOnce imported, you can use any of the functions listed below.\n\n## Functions\n\n - ```python\n def uuid4_examples(n: int = 10, *, uuids_as_strings: bool = True) -> Union[List[str], List[uuid.UUID]]:\n \"\"\"Create n uuids.\"\"\"\n ```\n - ```python\n def uuid4() -> str:\n \"\"\"Create a random UUID.\"\"\"\n ```\n - ```python\n def uuid3(name: str, *, namespace: Optional[uuid.UUID] = None) -> str:\n \"\"\"Create a random uuid based on the given name.\"\"\"\n ```\n - ```python\n def uuid5(name: str, *, namespace: Optional[uuid.UUID] = None) -> str:\n \"\"\"Create a random uuid based on the given name.\"\"\"\n ```\n - ```python\n def is_uuid(possible_uuid: Union[str, uuid.UUID], *, version: Optional[int] = None) -> bool:\n \"\"\"Return whether or not the possible_uuid is a uuid.\"\"\"\n ```\n\n## Development\n\n\ud83d\udc4b If you want to get involved in this project, we have some short, helpful guides below:\n\n- [contribute to this project \ud83e\udd47][contributing]\n- [test it \ud83e\uddea][local-dev]\n- [lint it \ud83e\uddf9][local-dev]\n- [explore it \ud83d\udd2d][local-dev]\n\nIf you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.\n\n## Credits\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [Python project template](https://github.com/fhightower-templates/python-project-template).\n\n[contributing]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#contributing-a-pr-\n[local-dev]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#local-development-\n\n\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3",
"summary": "Democritus functions for working with uuids.",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/democritus-project/d8s-uuids"
},
"split_keywords": [
"python",
"utility",
"uuids",
"uuid-utility",
"democritus"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9937713481aca13fd7e4056edad921e29c996a1a455e21893b03a076bb50ab0",
"md5": "c90fca1f5561e2a5c1f8048923c952f5",
"sha256": "8aa71fdf60dcdb26949643971734e25b5acfcb17e115bad345d9247b5855b7f5"
},
"downloads": -1,
"filename": "d8s_uuids-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c90fca1f5561e2a5c1f8048923c952f5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 19372,
"upload_time": "2021-05-07T10:58:43",
"upload_time_iso_8601": "2021-05-07T10:58:43.646783Z",
"url": "https://files.pythonhosted.org/packages/d9/93/7713481aca13fd7e4056edad921e29c996a1a455e21893b03a076bb50ab0/d8s_uuids-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4dab10b5ce30cf9da9db1bbef89f3f320a4b94ad0ca4fa8aac81cc9cc84afa4",
"md5": "0d6a214798acb83462276fa601cb255d",
"sha256": "1bf9ff07dfe4b11c258dc7ef8c5008579872ee5a318bd1839eb73232fde20c68"
},
"downloads": -1,
"filename": "d8s_uuids-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "0d6a214798acb83462276fa601cb255d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23179,
"upload_time": "2021-05-07T10:58:47",
"upload_time_iso_8601": "2021-05-07T10:58:47.714781Z",
"url": "https://files.pythonhosted.org/packages/c4/da/b10b5ce30cf9da9db1bbef89f3f320a4b94ad0ca4fa8aac81cc9cc84afa4/d8s_uuids-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-05-07 10:58:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "democritus-project",
"github_project": "d8s-uuids",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "d8s-hypothesis",
"specs": [
[
"==",
"0.*"
]
]
},
{
"name": "hypothesis",
"specs": []
},
{
"name": "importlib-metadata",
"specs": []
}
],
"lcname": "d8s-uuids"
}
JSON
