Skip to main content

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

Project description

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 in the docs directory.

Contributing

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

License

This project is licensed under the MIT License. See the LICENSE file 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.68261.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

surface_saver-2024.7.7.68261-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for surface_saver-2024.7.7.68261.tar.gz
Algorithm Hash digest
SHA256 f2badcc1de1a81c17238d5e7c6cf4a8baa017dbd1267c9ba266a7aa7bdfba046
MD5 c927179aec59aa52ef7c5e6a8cacf176
BLAKE2b-256 5def77a20b8bad471b6c92047cdf610a5d7f14551763b74591e2b78f8aaabae9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for surface_saver-2024.7.7.68261-py3-none-any.whl
Algorithm Hash digest
SHA256 a9b32c91947da0c01af2f1f97910182f8f1d9f65ac2f0eddb32535db80e2c4c8
MD5 ab7aaefd60d579331500633039e10fa4
BLAKE2b-256 cbaf12f6c22c64afefea6249cddbe82022deb0358587421f8f3c94df268ee1ef

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