https://github.com/fox-it/dissect.util
A Dissect module implementing various utility functions for the other Dissect modules.
https://github.com/fox-it/dissect.util
Last synced: 12 months ago
JSON representation
A Dissect module implementing various utility functions for the other Dissect modules.
- Host: GitHub
- URL: https://github.com/fox-it/dissect.util
- Owner: fox-it
- License: apache-2.0
- Created: 2022-07-20T13:07:49.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-01T07:01:06.000Z (12 months ago)
- Last Synced: 2025-07-01T08:20:01.501Z (12 months ago)
- Language: Python
- Homepage:
- Size: 159 KB
- Stars: 3
- Watchers: 11
- Forks: 7
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 () part of NCC Group Plc
().
Developed by the Dissect Team () and made available at .
License terms: Apache License 2.0 (). For more information, see the LICENSE file.