| Name | dissect.util JSON |
| Version |
3.19
JSON |
| download |
| home_page | None |
| Summary | A Dissect module implementing various utility functions for the other Dissect modules |
| upload_time | 2024-11-18 11:55:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | ~=3.9 |
| license | Apache License 2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# dissect.util
A Dissect module implementing various utility functions for the other Dissect modules. For more information, please see
[the documentation](https://docs.dissect.tools/en/latest/projects/dissect.util/index.html).
## Requirements
This project is part of the Dissect framework and requires Python.
Information on the supported Python versions can be found in the Getting Started section of [the documentation](https://docs.dissect.tools/en/latest/index.html#getting-started).
## Installation
`dissect.util` is available on [PyPI](https://pypi.org/project/dissect.util/).
```bash
pip install dissect.util
```
`dissect.util` includes pure Python implementations of the lz4 and lzo decompression algorithms. To automatically use
the faster, native (C-based) lz4 and lzo implementations in other Dissect projects, install the package with the lz4 and
lzo extras:
```bash
pip install "dissect.util[lz4,lzo]"
```
Unfortunately there is no binary `python-lzo` wheel for PyPy installations on Windows, so it won't be installed there.
This module including the lz4 and lzo extras is also automatically installed if you install the `dissect` package.
## Build and test instructions
This project uses `tox` to build source and wheel distributions. Run the following command from the root folder to build
these:
```bash
tox -e build
```
The build artifacts can be found in the `dist/` directory.
`tox` is also used to run linting and unit tests in a self-contained environment. To run both linting and unit tests
using the default installed Python version, run:
```bash
tox
```
For a more elaborate explanation on how to build and test the project, please see [the
documentation](https://docs.dissect.tools/en/latest/contributing/tooling.html).
## Contributing
The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please
refer to [the development guide](https://docs.dissect.tools/en/latest/contributing/developing.html).
## Copyright and license
Dissect is released as open source by Fox-IT (<https://www.fox-it.com>) part of NCC Group Plc
(<https://www.nccgroup.com>).
Developed by the Dissect Team (<dissect@fox-it.com>) and made available at <https://github.com/fox-it/dissect>.
License terms: Apache License 2.0 (<https://www.apache.org/licenses/LICENSE-2.0>). For more information, see the LICENSE file.
Raw data
{
"_id": null,
"home_page": null,
"name": "dissect.util",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Dissect Team <dissect@fox-it.com>",
"download_url": "https://files.pythonhosted.org/packages/7c/05/c4e6fd877a2132b386164181dafc6baac76640b65770435aa84fc6e68d36/dissect_util-3.19.tar.gz",
"platform": null,
"description": "# dissect.util\n\nA Dissect module implementing various utility functions for the other Dissect modules. For more information, please see\n[the documentation](https://docs.dissect.tools/en/latest/projects/dissect.util/index.html).\n\n## Requirements\n\nThis project is part of the Dissect framework and requires Python.\n\nInformation on the supported Python versions can be found in the Getting Started section of [the documentation](https://docs.dissect.tools/en/latest/index.html#getting-started).\n\n## Installation\n\n`dissect.util` is available on [PyPI](https://pypi.org/project/dissect.util/).\n\n```bash\npip install dissect.util\n```\n\n`dissect.util` includes pure Python implementations of the lz4 and lzo decompression algorithms. To automatically use\nthe faster, native (C-based) lz4 and lzo implementations in other Dissect projects, install the package with the lz4 and\nlzo extras:\n\n```bash\npip install \"dissect.util[lz4,lzo]\"\n```\n\nUnfortunately there is no binary `python-lzo` wheel for PyPy installations on Windows, so it won't be installed there.\n\nThis module including the lz4 and lzo extras is also automatically installed if you install the `dissect` package.\n\n## Build and test instructions\n\nThis project uses `tox` to build source and wheel distributions. Run the following command from the root folder to build\nthese:\n\n```bash\ntox -e build\n```\n\nThe build artifacts can be found in the `dist/` directory.\n\n`tox` is also used to run linting and unit tests in a self-contained environment. To run both linting and unit tests\nusing the default installed Python version, run:\n\n```bash\ntox\n```\n\nFor a more elaborate explanation on how to build and test the project, please see [the\ndocumentation](https://docs.dissect.tools/en/latest/contributing/tooling.html).\n\n## Contributing\n\nThe Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please\nrefer to [the development guide](https://docs.dissect.tools/en/latest/contributing/developing.html).\n\n## Copyright and license\n\nDissect is released as open source by Fox-IT (<https://www.fox-it.com>) part of NCC Group Plc\n(<https://www.nccgroup.com>).\n\nDeveloped by the Dissect Team (<dissect@fox-it.com>) and made available at <https://github.com/fox-it/dissect>.\n\nLicense terms: Apache License 2.0 (<https://www.apache.org/licenses/LICENSE-2.0>). For more information, see the LICENSE file.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A Dissect module implementing various utility functions for the other Dissect modules",
"version": "3.19",
"project_urls": {
"documentation": "https://docs.dissect.tools/en/latest/projects/dissect.util",
"homepage": "https://dissect.tools",
"repository": "https://github.com/fox-it/dissect.util"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e0f7c454c9ff9880f4589f9f41c15d81d105b617480053a910c670220b331ac",
"md5": "efc2cf7330feb8cdab02a7a7ca0c2076",
"sha256": "a9407de3e4a5523c0cbbb950e582e7a240fa90d17599e586bd50519ad5dd2f63"
},
"downloads": -1,
"filename": "dissect.util-3.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "efc2cf7330feb8cdab02a7a7ca0c2076",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.9",
"size": 34945,
"upload_time": "2024-11-18T11:55:20",
"upload_time_iso_8601": "2024-11-18T11:55:20.080899Z",
"url": "https://files.pythonhosted.org/packages/4e/0f/7c454c9ff9880f4589f9f41c15d81d105b617480053a910c670220b331ac/dissect.util-3.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c05c4e6fd877a2132b386164181dafc6baac76640b65770435aa84fc6e68d36",
"md5": "b7ea3c10b24fc87fb8b1d157f7bcdea5",
"sha256": "c942ea396eb01862d1f3bb2f750fcafbff08aeaf603b57c82b450270524f7c06"
},
"downloads": -1,
"filename": "dissect_util-3.19.tar.gz",
"has_sig": false,
"md5_digest": "b7ea3c10b24fc87fb8b1d157f7bcdea5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.9",
"size": 51882,
"upload_time": "2024-11-18T11:55:21",
"upload_time_iso_8601": "2024-11-18T11:55:21.950813Z",
"url": "https://files.pythonhosted.org/packages/7c/05/c4e6fd877a2132b386164181dafc6baac76640b65770435aa84fc6e68d36/dissect_util-3.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 11:55:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fox-it",
"github_project": "dissect.util",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "dissect.util"
}
