A custom builder to build zipped directories
Project description
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 dairiki@dairiki.org
License
hatch-zipped-directory
is distributed under the terms of the
MIT license.
Changes
0.1.0b3 (2023-05-10)
Features
- Refactor JSON metadata code. Now we use
hatchling
to generate conventionall RFC 822-formatted distribution metadata, then convert that to JSON, explicitly following the steps outline in PEP 566. Among other things, this allows configuration of the Metadata-Version by settingtool.hatch.build.targets.zipped-directory.core-metadata-version
.
Tests
- We now have 100% test coverage.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hatch_zipped_directory-0.1.0b3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 967a57fd4970120c4e72e2e178e02d7e0db8fa5f9282c468ff2dc80a00dd6ba7 |
|
MD5 | 59434e6f2c87aee8850bcb26d5c1e80c |
|
BLAKE2b-256 | 368a14e7d5dd6e323028f53d9a2cc5167ed4f0dfd206505f6782f331e8e9807a |
Hashes for hatch_zipped_directory-0.1.0b3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9968b0ed803b2fe149e27f039567c401f6b11584c1684f87b74e4d770083317d |
|
MD5 | 9135b3277b4455b5439d77a6ca5658db |
|
BLAKE2b-256 | 0864628797cd3a77cbfc432618b67b6f05241867be4b4a10ebf20a4857b2105e |