dissect.contrib

This project is a meta package. It reserves the namespace for Dissect packages made by external contributors.

We encourage contributions to the Dissect project, in both the existing projects as well as entirely new ones. We kindly request that you use the dissect.contrib namespace prefix for your package names. For example, a new project for myfilesystem would be called dissect.contrib.myfilesystem.

For more information on developing for Dissect, please see the documentation.

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:

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:

tox

For a more elaborate explanation on how to build and test the project, please see the documentation.

Contributing

The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please refer to the style guide.

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.contrib.

License terms: AGPL3 (https://www.gnu.org/licenses/agpl-3.0.html). For more information, see the LICENSE file.