-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5d0ddf4
commit 0641437
Showing
1 changed file
with
31 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,38 @@ | ||
Introduction | ||
============ | ||
|
||
This project is python port of Validator.js which is a library for string validation. | ||
This project is inspired from Validator.js which is a library for string validation. | ||
So people who are familiar with Validator.js can easily switch to this library. | ||
|
||
It is also a good way to learn how to port a library from one language to another. | ||
I have tried to keep the code as similar as possible to the original library. | ||
if you find any bugs or have any suggestions please open an issue. | ||
if you want to contribute please open a pull request. | ||
This library is written in pure python and is very easy to use. | ||
It is a simple library that can be used to validate strings, documents, emails, dates, urls, domain names, etc. | ||
|
||
Installation | ||
============ | ||
|
||
To install the library, you can use pip: | ||
|
||
```bash | ||
pip install sanatio | ||
``` | ||
|
||
Usage | ||
===== | ||
|
||
```python | ||
from sanatio import Validator | ||
val = Validator() | ||
# Check if the string is equal to the given value | ||
```python | ||
val.equals("abc", "abc") # True | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
|
||
|