Skip to content

Commit

Permalink
Added starting point to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Attumm committed Jul 26, 2021
1 parent ea86f60 commit 27f3b45
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,19 @@ Throws `Invalid` exception when validation fails. Maat has a fail fast policy.
'success'
```

## Starting Point Example
```python
validation = {
"int ": {"type": "int", "cast": True, "min_amount": 1, "max_amount": 150},
"float ": {"type": "float", "cast": True, "min_amount": 1, "max_amount": 150},
"list ": {"type": "list", "min_amount": 1, "max_amount": 5},
"dict ": {"type": "dict", "min_amount": 1, "max_amount": 2, "key_regex": r"(\w+)"},
"string": {"type": "str", "cast": True, "min_length": 1,
"max_length": 12, "regex": r"(\w+ )(\w+)", "choices": ["John Doe", "Jane Doe"]
}
}
```

## Installation
```sh
pip install maat
Expand Down

0 comments on commit 27f3b45

Please sign in to comment.