Metadata-Version: 2.1
Name: typeschemalib
Version: 1.2
Summary: A yaml like schema that can be used to check dictionaries for correct schema
Home-page: https://github.com/JakeRoggenbuck/typeschemalib
Author: Jake Roggenbuck
Author-email: jake@jr0.org
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown

# typeschemalib
A yaml like schema that can be used to check dictionaries for correct schema

## Schema file
#### schema example
```
point: Int
my_string: Str
grade: Float
```

#### data example
```json
{"point": 45, "my_string": "Hey", "grade": 4.5}
```

## Checking data for correct schema
### Test parse with stml file
```py
from typeschemalib import typeschemalib
from termcolor import colored


if __name__ == "__main__":
    """Test parse with stml file"""
    schema_file = "test.stml"
    data = {"point": 45, "my_string": "Hey", "grade": 4}

    lines = typeschemalib.StmlReader(schema_file).lines
    schema_dict = typeschemalib.StmlParser(lines).schema_dict

    dataChecker = typeschemalib.DataChecker(schema_dict, data)
    valid = dataChecker.check_type()
    if valid is True:
        print(colored(valid, 'green'))
    else:
        print(colored(valid, 'red'))
```

## Todo
Make schema have regex
Make schema have functions or options to validate data


