Metadata-Version: 2.1
Name: schema-validator-halpa
Version: 0.0.6rc1
Summary: A utility to validate JSON schemas with jsonschema with simplejson
Home-page: https://gitlab.com/Halpa/schema-validator-halpa
Author: Halpa AB
Author-email: dev@halpa.se
License: UNKNOWN
Description: # Package
        
        This package is a wrapper for jsonschema and simplejson to simplyfy JSON schema validation specified by [JSON Schema Draft 7](https://json-schema.org/specification-links.html#draft-7) (link to [IETF](https://tools.ietf.org/html/draft-handrews-json-schema-01)).
        
        ## Example
        
        ```python
        
        from validator import validate
        
        # Define the validation schema
        schema = {
            "type": "object",
            "required": [
                "name",
                "age",
            ],
            "properties": {
                "name": { "type": "string" },
                "age": { "type": "number" },
            }
        }
        
        # Data to be validated
        data = {
            "name": "Daniel",
            "age": 30,
        }
        
        # Validate and run
        validation = validate(schema, data)
        if validation==True:
            # do something with data, e.g. create a new friend
        else:
            print(validation) # will show a well formated dict with errors
        ```
        
        > Note: More examples can be shown in the tests
        
        ## Contribute
        
        This package is intended to be used by private projects. But go ahead if you like and make comments and pull requests and I might look into it.
        
        ### Install the package
        
        ```sh
        python -m venv venv
        source venv/bin/activate
        pip install -r requirements.txt
        ```
        
        ### Run tests
        
        ```sh
        python -m pytest -m validator -s
        ```
        
        ### Upload package
        
        ```sh
        
        # Set your user with python keyring
        python3 -m keyring set https://upload.pypi.org/legacy/ $username
        # substitue $username with your actual username
        
        # Update packaging tools
        python3 -m pip install --user --upgrade setuptools wheel twine
        
        # Remove dist folder
        rm -rf dist/*
        
        # Create a new dist
        python3 setup.py sdist bdist_wheel
        # Above command creates
        # dist/
        #  schema-validator-halpa-0.0.5-py3-none-any.whl
        #  schema-validator-halpa-0.0.5.tar.gz
        # where "0.0.1" is equivalent to value in "version" from setup.py
        
        # Upload the package
        python3 -m twine upload dist/*
        
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
