hatch-zipped-directory 0.1.0b2

A custom builder to build zipped directories

hatch-zipped-directory

---

This is a Hatch plugin that provides a custom builder to support building zip archives for quasi-manual installation into various foreign package installation systems. (Specifically, I use this for packaging Inkscape extensions and symbols libraries, but it may be useful in other contexts, such as deploying to cloud compute platforms.)

The builder creates a zip archive. All the contents of the zip archive will be included under a single specific top-level directory. The default name of the top-level directory is a file-name-safe version of the project name, however the name of the directory may be configured by setting the install-name key in the target-specific configuration section. This behavior may be disabled by setting install-name = ''.

In addition to whatever files are selected for inclusion in the archive via Hatch’s regular build configuration settings, any configured project README and license files will be included in the top level of the install directory within the zip archive.

As well, a METADATA.json file containing the project metadata in JSON format (as described in PEP 566) will be included in the top level of the install directory within the zip archive.

Example

Assume a project source directory looking something like:

.
├── pyproject.toml
├── LICENSE.txt
├── README.md
├── src
│   ├── subdir
│   │   ├── data.txt
│   │   └── more-code.py
│   └── my-code.py
└── tests
    └── test_foo.py

Where pyproject.toml looks like:

[build-system]
requires = [
    "hatchling",
    "hatch-zipped-directory",
]
build-backend = "hatchling.build"

[project]
name = "test-project"
version = "0.42"

[tool.hatch.build.targets.zipped-directory]
install-name = "org.example.test"
sources = [
    "/src",
]

Then, running

hatch build --target zipped-directory

will build a zip archive named dist/test_project-0.42.zip with the following structure:

.
└── org.example.test
    ├── LICENSE.txt
    ├── METADATA.json
    ├── README.md
    ├── my-code.py
    └── subdir
        ├── data.txt
        └── more-code.py

Author

Jeff Dairiki [e-mail]

License

hatch-zipped-directory is distributed under the terms of the MIT license.

Changes

0.1.0b2 (2023-01-10)

Features

• The prefixing of file names under a top-level directory in the zip archive can now be disabled by setting install-name = "". Thank you @gwerbin(#1)

Bugs

• Use explicit encoding in hatch metadata hook (for Windows).

0.1.0b1 (2022-10-07)

Initial release.