Skip to content

Commit fc3559d

Browse files
committed
chore: improve readme
1 parent 012174d commit fc3559d

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Validator | Description
7474
**is_hexadecimal(str)** | check if the string is a hexadecimal number.
7575
**is_hsl(str)** | check if the string is an HSL (hue, saturation, lightness, optional alpha) color based on [CSS Colors Level 4 specification](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).<br/><br/>Comma-separated format supported. Space-separated format supported with the exception of a few edge cases (ex: `hsl(200grad+.1%62%/1)`).
7676
**is_html_element(str, options)** | check if the provided string represents an html element. The options dictionary accepts a `contains` flag which can be set to *True*, fo so it will check if the provided string contains an html element. It is defaulted to *False*, which means that it will expect an proper html element to be valid.
77-
**is_iban(str, country_code, options)** | check if the provided string is a valid [iban](https://en.wikipedia.org/wiki/International_Bank_Account_Number), `country_code` is an optional argument which if provided will check the input string if its a valid iban for that specified country and the options is an optional dictionary it does accept a `insensitive` property which will ignore character case upon validation.<br> Available *country codes*: `AD,AE,AL,AT,AZ,BA,BE,BG,BH,BR,BY,CH,CR,CY,CZ,DE,DK,DO,EE,EG,ES,FI,FO,FR,GB,GE,GI,GL,GR,GT,HR,HU,IE,IL,IQ,IS,IT,JO,KW,KZ,LB,LC,LI,LT,LU,LV,MC,MD,ME,MK,MR,MT,MU,NL,NO,PK,PL,PS,PT,QA,RO,RS,SA,SC,SE,SI,SK,SM,ST,SV,TL,TN,TR,UA,VA,VG`.
77+
**is_iban(str, country_code, options)** | check if the provided string is a valid [iban](https://en.wikipedia.org/wiki/International_Bank_Account_Number), `country_code` is an optional argument which if provided will check the input string if its a valid iban for that specified country and the options is an optional dictionary it does accept a `insensitive` property which will ignore character case upon validation.<br> Available *country codes*: `AD, AE, AL, AT, AZ, BA, BE, BG, BH, BR, BY, CH, CR, CY, CZ, DE, DK, DO, EE, EG, ES, FI, FO, FR, GB, GE, GI, GL, GR, GT, HR, HU, IE, IL, IQ, IS, IT, JO, KW, KZ, LB, LC, LI, LT, LU, LV, MC, MD, ME, MK, MR, MT, MU, NL, NO, PK, PL, PS, PT, QA, RO, RS, SA, SC, SE, SI, SK, SM, ST, SV, TL, TN, TR, UA, VA, VG`.
7878
**is_imei(str, options)** | check if the string is a valid IMEI number. Imei should be of format `###############` or `##-######-######-#`.<br/><br/>`options` is an dictionary which can contain the property `allow_hyphens` (bool - default value is *False*). If the `allow_hyphens` prop is set to *True*, it will validate the IMEI with the hyphens.
7979
**is_int(str, options)** | check if the string is an integer.<br/><br/>`options` is an dictionary which can contain the keys `min` and/or `max` to check the integer is within boundaries (e.g. `{ "min": 10, "max": 99 }`). `options` can also contain the key `allow_leading_zeroes`, which when set to false will disallow integer values with leading zeroes (e.g. `{ "allow_leading_zeroes": False }`). Finally, `options` can contain the keys `gt` and/or `lt` which will enforce integers being greater than or less than, respectively, the value provided (e.g. `{ "gt": 1, "lt": 4 }` for a number between 1 and 4).
8080
**is_ip(str, version)** | check if the string is an IP _(version 4 or 6)_, if the version is not set it will validate the input for any version.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
MAJOR = 0
77
MINOR = 13
8-
PATCH = 2
8+
PATCH = 3
99

1010
VERSION = '{}.{}.{}'.format(MAJOR, MINOR, PATCH)
1111
DESCRIPTION = 'String validation and sanitization'

0 commit comments

Comments
 (0)