# Democritus Hashes
[](https://pypi.python.org/pypi/d8s-hashes)
[](https://github.com/democritus-project/d8s-hashes/actions)
[](https://github.com/democritus-project/d8s-hashes/actions)
[](https://codecov.io/gh/democritus-project/d8s-hashes)
[](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 hashes.
[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-hashes
```
## Usage
You import the library like:
```python
from d8s_hashes import *
```
Once imported, you can use any of the functions listed below.
## Functions
- ```python
def ssdeep(input_string: Union[str, bytes]) -> str:
"""."""
```
- ```python
def ssdeep_compare(ssdeep_1: str, ssdeep_2: str) -> int:
"""."""
```
- ```python
def md5(input_string: Union[str, bytes]) -> str:
"""."""
```
- ```python
def sha1(input_string: Union[str, bytes]) -> str:
"""."""
```
- ```python
def sha256(input_string: Union[str, bytes]) -> str:
"""."""
```
- ```python
def sha512(input_string: Union[str, bytes]) -> str:
"""Return the sha512 hash of the string."""
```
## 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-hashes",
"name": "d8s-hashes",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "democritus,utility,python,hashes,hashes-utility,md5,sha1,sha256,sha512,ssdeep_compare,ssdeep",
"author": "Floyd Hightower",
"author_email": "floyd.hightower27@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/01/0c/5813281a83a0dd2476e5e1dde424ad487c20c42028a7f492ce7d5085bf73/d8s_hashes-0.6.0.tar.gz",
"platform": "",
"description": "# Democritus Hashes\n\n[](https://pypi.python.org/pypi/d8s-hashes)\n[](https://github.com/democritus-project/d8s-hashes/actions)\n[](https://github.com/democritus-project/d8s-hashes/actions)\n[](https://codecov.io/gh/democritus-project/d8s-hashes)\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 hashes.\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-hashes\n```\n\n## Usage\n\nYou import the library like:\n\n```python\nfrom d8s_hashes import *\n```\n\nOnce imported, you can use any of the functions listed below.\n\n## Functions\n\n - ```python\n def ssdeep(input_string: Union[str, bytes]) -> str:\n \"\"\".\"\"\"\n ```\n - ```python\n def ssdeep_compare(ssdeep_1: str, ssdeep_2: str) -> int:\n \"\"\".\"\"\"\n ```\n - ```python\n def md5(input_string: Union[str, bytes]) -> str:\n \"\"\".\"\"\"\n ```\n - ```python\n def sha1(input_string: Union[str, bytes]) -> str:\n \"\"\".\"\"\"\n ```\n - ```python\n def sha256(input_string: Union[str, bytes]) -> str:\n \"\"\".\"\"\"\n ```\n - ```python\n def sha512(input_string: Union[str, bytes]) -> str:\n \"\"\"Return the sha512 hash of the string.\"\"\"\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 hashes.",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/democritus-project/d8s-hashes"
},
"split_keywords": [
"democritus",
"utility",
"python",
"hashes",
"hashes-utility",
"md5",
"sha1",
"sha256",
"sha512",
"ssdeep_compare",
"ssdeep"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55603e51939fb21c30a67b533f779eb71e47a20af3485fd6162e504e44c4599b",
"md5": "7c7ef1ddd9d544f432b83ebeb110d8f1",
"sha256": "92f5fe670de1bafc0b3d4afe1c52bc8f7dcbd1e381f670a02d7cebb03b7a0d1f"
},
"downloads": -1,
"filename": "d8s_hashes-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c7ef1ddd9d544f432b83ebeb110d8f1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 20058,
"upload_time": "2021-05-07T10:53:33",
"upload_time_iso_8601": "2021-05-07T10:53:33.138779Z",
"url": "https://files.pythonhosted.org/packages/55/60/3e51939fb21c30a67b533f779eb71e47a20af3485fd6162e504e44c4599b/d8s_hashes-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "010c5813281a83a0dd2476e5e1dde424ad487c20c42028a7f492ce7d5085bf73",
"md5": "36ddcb02cfa5ee6f32ef995cdf6a8a48",
"sha256": "dd95b6278f29f42042b315f51d14acb24962154ead759654d55c2dc6f6fa34ea"
},
"downloads": -1,
"filename": "d8s_hashes-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "36ddcb02cfa5ee6f32ef995cdf6a8a48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23748,
"upload_time": "2021-05-07T10:53:35",
"upload_time_iso_8601": "2021-05-07T10:53:35.068816Z",
"url": "https://files.pythonhosted.org/packages/01/0c/5813281a83a0dd2476e5e1dde424ad487c20c42028a7f492ce7d5085bf73/d8s_hashes-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-05-07 10:53:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "democritus-project",
"github_project": "d8s-hashes",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "d8s-hashes"
}
JSON
