Metadata-Version: 2.4
Name: malpz
Version: 11.0.13
Summary: The MALPZ (Malware Pickled Zip) format describes a method of neutering malware while providing a simple, extensible mechanism for capturing metadata
Project-URL: Documentation, https://australiancybersecuritycentre.github.io/azul/
Project-URL: Repository, https://github.com/AustralianCyberSecurityCentre/malpz
Author: Azul
License-Expression: MIT
License-File: license.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# malpz

## Overview

The MALPZ (Malware Pickled Zip) format describes a method of neutering malware
while providing a simple, extensible mechanism for capturing metadata.

This project is deprecated and we encourage use of CART format instead.

https://github.com/CybercentreCanada/cart

## Dependency management

Dependencies are managed in the pyproject.toml and debian.txt file.

Version pinning is achieved using the `uv.lock` file.
Because the `uv.lock` file is configured to use a private UV registry, external developers using UV will need to delete the existing `uv.lock` file and update the project configuration to point to the publicly available PyPI registry instead.

To add new dependencies it's recommended to use uv with the command `uv add <new-package>`
    or for a dev package `uv add --dev <new-dev-package>`

The tool used for linting and managing styling is `ruff` and it is configured via `pyproject.toml`

The debian.txt file manages the debian dependencies that need to be installed on development systems and docker images.

Sometimes the debian.txt file is insufficient and in this case the Dockerfile may need to be modified directly to
install complex dependencies.
