Metadata-Version: 2.1
Name: surface_saver
Version: 2024.7.7.68261
Summary: Help to box up the stuff that's cluttering horizontal surfaces 
Author-email: Moshe Zadka <moshez@zadka.club>
License: Permission is hereby granted, free of charge, to any person obtaining a
        copy of this software and associated documentation files (the "Software"),
        to deal in the Software without restriction, including without limitation the
        rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is furnished
        to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
        INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
        PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
        HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
        CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
        OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/moshez/surface_saver
Description-Content-Type: text/x-rst
Requires-Dist: gather
Requires-Dist: jsonschema
Requires-Dist: commander_data
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: virtue; extra == "test"
Provides-Extra: lint
Requires-Dist: flake8; extra == "lint"
Requires-Dist: black; extra == "lint"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Provides-Extra: tests
Requires-Dist: virtue; extra == "tests"
Requires-Dist: pyhamcrest; extra == "tests"
Requires-Dist: coverage; extra == "tests"
Provides-Extra: mypy
Requires-Dist: mypy; extra == "mypy"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"

Surface Saver
=============

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:

.. code-block:: bash

    pip install surface_saver

Quick Start
-----------

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

   .. code-block:: json

       [
           {"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:

   .. code-block:: bash

       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.
