Zipschema
Zipschema is a CLI tool for validating zipschema YAML files, validating ZIP file contents against these schemas, and generating documentation (Markdown or AsciiDoc).
Zipschema was written in order to allow for validation of "meta formats" which use the zip file as a container. While mostly these are loosely defined, this Zipschema was created to allow for validation of those files, and the files they contain.
Features
- Schema Validation: Validate the structure of your zipschema YAML file.
- ZIP Validation: Validate the contents of a ZIP file against a zipschema.
- Documentation Generation: Generate Markdown or AsciiDoc documentation from a zipschema.
Installation
To install zipschema, run:
pip install zipschema
Usage
Validate a zipschema YAML file:
zipschema validate-schema path/to/zipschema.yaml
Validate a ZIP file against a zipschema:
zipschema validate-zip path/to/zipschema.yaml path/to/zipfile.zip
Generate documentation from a zipschema:
zipschema generate-docs path/to/zipschema.yaml --format markdown
License
This project is licensed under the MIT License.
1 maintainer
Metadata
1 maintainer
Release files for zipschema 1.0.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| zipschema-1.0.12.tar.gz | 8.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| zipschema-1.0.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.3 kB
Release files / zipschema-1.0.12.tar.gz
| Download URL | zipschema-1.0.12.tar.gz |
|---|---|
| Size | 8.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd370fdc4774a0e78cbc6c1d212c5eff116467e84d7a36fff73db192a82419db
|
|
BLAKE2b-256 checksum How to use checksums |
085a2f294376a20f919f9629fa3798a3bfb1dfd52adc5175aec2bc7c030c6b21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.4
|
Release files / zipschema-1.0.12-py3-none-any.whl
| Download URL | zipschema-1.0.12-py3-none-any.whl |
|---|---|
| Size | 8.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1becfa563c6094b99bc2af6a7f0924dd694c09521840f06195fe9850990ecb99
|
|
BLAKE2b-256 checksum How to use checksums |
be0fe820a71aaf0d133d8c7137cf756a7ef05ebb2c4f7eef1d8280596548d9b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.4
|
