Metadata-Version: 2.1
Name: dissect.contrib
Version: 1.1.dev3
Summary: This project is a meta package: it reserves the namespace for Dissect packages made by external contributors
Home-page: https://github.com/fox-it/dissect.contrib
Author: Dissect Team
Author-email: dissect@fox-it.com
License: Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Requires-Python: ~=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: COPYRIGHT

# 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](https://docs.dissect.tools/en/latest/contributing/developing.html).

## 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/developing.html#building-testing).

## Contributing

The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please
refer to [the style guide](https://docs.dissect.tools/en/latest/contributing/style-guide.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.contrib>.

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