Skip to main content

Help to box up the stuff that's cluttering horizontal surfaces

Project description

Documentation Status PyPI Version

Surface Saver is a tool designed to help organize and validate your storage system. It provides a simple way to keep track of items in various storage boxes and ensures that your inventory data is correctly formatted.

Installation

Surface Saver is available on PyPI. You can install it using pip:

pip install surface_saver

Quick Start

  1. Create a root JSON file (e.g., boxes.json) listing your storage boxes:

    [
        {"name": "Box One"},
        {"name": "Box Two"}
    ]
  2. For each box, create a directory (e.g., box-one, box-two) containing JSON files that describe the items in that box.

  3. Validate your storage system:

    python -m surface_saver validate path/to/boxes.json

    This command will check all JSON files in the directories specified by boxes.json and report any validation errors.

Features

  • Organize items into named boxes

  • Validate JSON files against a predefined schema

  • Command-line interface for easy validation

Documentation

For more detailed information and advanced usage, please refer to the full documentation on Read the Docs.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License. See the licence in pyproject.toml for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

surface_saver-2024.7.7.68985.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

surface_saver-2024.7.7.68985-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file surface_saver-2024.7.7.68985.tar.gz.

File metadata

File hashes

Hashes for surface_saver-2024.7.7.68985.tar.gz
Algorithm Hash digest
SHA256 f1536dc830fc8b03f098dcb8c6af9040c6a874c3b8ebf15705ef25c8c6ad36c0
MD5 df815bba9097dbf316d766914e636ea6
BLAKE2b-256 3bd2281f79371ad17673895a5d550ab48127f9f67d87378124442b76632d540d

See more details on using hashes here.

Provenance

File details

Details for the file surface_saver-2024.7.7.68985-py3-none-any.whl.

File metadata

File hashes

Hashes for surface_saver-2024.7.7.68985-py3-none-any.whl
Algorithm Hash digest
SHA256 ada16633e5a87a62b168e13c31579fb808341b2f279db799043b68453103ddc3
MD5 dea08f963d75edf9617e6009594d14ef
BLAKE2b-256 d0db1368d21bd14dd4abf2022ac7770def016f7e3367b8932a9b9091a23187bf

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page