Skip to content

Commit dc1934f

Browse files
nandgatornandgator
committed
Deployed e79d75f to dev with MkDocs 1.5.3 and mike 2.0.0
1 parent 6554a79 commit dc1934f

97 files changed

Lines changed: 13619 additions & 120 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎dev/404.html‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,26 @@
269269

270270

271271

272+
<li class="md-nav__item">
273+
<a href="/pyvalidators/dev/install_and_use/" class="md-nav__link">
274+
275+
276+
<span class="md-ellipsis">
277+
Install and Use
278+
</span>
279+
280+
281+
</a>
282+
</li>
283+
284+
285+
286+
287+
288+
289+
290+
291+
272292

273293

274294

@@ -277,10 +297,10 @@
277297

278298

279299

280-
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
300+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
281301

282302

283-
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
303+
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
284304

285305

286306
<span class="md-ellipsis">
@@ -291,8 +311,8 @@
291311
<span class="md-nav__icon md-icon"></span>
292312
</label>
293313

294-
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
295-
<label class="md-nav__title" for="__nav_2">
314+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
315+
<label class="md-nav__title" for="__nav_3">
296316
<span class="md-nav__icon md-icon"></span>
297317
API
298318
</label>
@@ -755,7 +775,7 @@ <h1>404 - Not found</h1>
755775
</div>
756776

757777

758-
<script id="__config" type="application/json">{"base": "/pyvalidators/dev", "features": [], "search": "/pyvalidators/dev/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "stable", "provider": "mike"}}</script>
778+
<script id="__config" type="application/json">{"base": "/pyvalidators/dev", "features": ["content.code.copy"], "search": "/pyvalidators/dev/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "stable", "provider": "mike"}}</script>
759779

760780

761781
<script src="/pyvalidators/dev/assets/javascripts/bundle.bd41221c.min.js"></script>

‎dev/_build/man/validators.1‎

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "VALIDATORS" "1" "Mar 24, 2024" "0.24.0" "validators"
30+
.TH "VALIDATORS" "1" "Mar 26, 2024" "0.24.0" "validators"
3131
.SH NAME
3232
validators \- Python Data Validation for Humans™
3333
.sp
@@ -61,6 +61,76 @@ True
6161
.IP \(bu 2
6262
\fI\%Code\fP
6363
.UNINDENT
64+
.SS Install and Use
65+
.SS Installation
66+
.sp
67+
Execute the following command:
68+
.INDENT 0.0
69+
.INDENT 3.5
70+
.sp
71+
.nf
72+
.ft C
73+
pip install validators
74+
.ft P
75+
.fi
76+
.UNINDENT
77+
.UNINDENT
78+
.INDENT 0.0
79+
.INDENT 3.5
80+
It\(aqs preferable to use \fBpip\fP within a virtual environment.
81+
.UNINDENT
82+
.UNINDENT
83+
.SS Usage
84+
.INDENT 0.0
85+
.INDENT 3.5
86+
.sp
87+
.nf
88+
.ft C
89+
import validators
90+
print(validators.email(\(aqsomeone@example.com\(aq))
91+
.ft P
92+
.fi
93+
.UNINDENT
94+
.UNINDENT
95+
.SS To raise validation error
96+
.INDENT 0.0
97+
.IP 1. 3
98+
Either set the environment variable \fBRAISE_VALIDATION_ERROR\fP to
99+
\fBTrue\fP
100+
.INDENT 3.0
101+
.INDENT 3.5
102+
.sp
103+
.nf
104+
.ft C
105+
$ export RAISE_VALIDATION_ERROR=True
106+
$ python \-c \(dqfrom validators import url; print(url(\(aqhttps//bad_url\(aq))\(dq
107+
Traceback (most recent call last):
108+
File \(dq<string>\(dq, line 1, in <module>
109+
File \(dq/path/to/lib/validators/utils.py\(dq, line 87, in wrapper
110+
raise ValidationError(func, _func_args_as_dict(func, *args, **kwargs))
111+
validators.utils.ValidationError: ValidationError(func=url, args={\(aqvalue\(aq: \(aqhttps//bad_url\(aq})
112+
.ft P
113+
.fi
114+
.UNINDENT
115+
.UNINDENT
116+
.IP 2. 3
117+
Or pass \fBr_ve=True\fP to each caller function:
118+
.INDENT 3.0
119+
.INDENT 3.5
120+
.sp
121+
.nf
122+
.ft C
123+
$ python \-c \(dqfrom validators.card import visa; print(visa(\(aqbad_visa_number\(aq, r_ve=True))\(dq
124+
Traceback (most recent call last):
125+
File \(dq<string>\(dq, line 1, in <module>
126+
File \(dq/path/to/lib/validators/utils.py\(dq, line 87, in wrapper
127+
raise ValidationError(func, _func_args_as_dict(func, *args, **kwargs))
128+
validators.utils.ValidationError: ValidationError(func=visa, args={\(aqvalue\(aq: \(aqbad_visa_number\(aq})
129+
.ft P
130+
.fi
131+
.UNINDENT
132+
.UNINDENT
133+
.UNINDENT
64134
.SS between
65135
.INDENT 0.0
66136
.TP

‎dev/_build/web/_sources/api/between.rst.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
between
2+
-------
3+
4+
.. module:: validators.between
5+
.. autofunction:: between

‎dev/_build/web/_sources/api/btc_address.rst.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
btc_address
2+
-----------
3+
4+
.. module:: validators.btc_address
5+
.. autofunction:: btc_address

‎dev/_build/web/_sources/api/card.rst.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
card
2+
----
3+
4+
.. module:: validators.card
5+
.. autofunction:: amex
6+
.. autofunction:: card_number
7+
.. autofunction:: diners
8+
.. autofunction:: discover
9+
.. autofunction:: jcb
10+
.. autofunction:: mastercard
11+
.. autofunction:: unionpay
12+
.. autofunction:: visa

‎dev/_build/web/_sources/api/country_code.rst.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
country_code
2+
------------
3+
4+
.. module:: validators.country_code
5+
.. autofunction:: country_code

‎dev/_build/web/_sources/api/domain.rst.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
domain
2+
------
3+
4+
.. module:: validators.domain
5+
.. autofunction:: domain

‎dev/_build/web/_sources/api/email.rst.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
email
2+
-----
3+
4+
.. module:: validators.email
5+
.. autofunction:: email

‎dev/_build/web/_sources/api/hashes.rst.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
hashes
2+
------
3+
4+
.. module:: validators.hashes
5+
.. autofunction:: md5
6+
.. autofunction:: sha1
7+
.. autofunction:: sha224
8+
.. autofunction:: sha256
9+
.. autofunction:: sha512

‎dev/_build/web/_sources/api/hostname.rst.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
hostname
2+
--------
3+
4+
.. module:: validators.hostname
5+
.. autofunction:: hostname

0 commit comments

Comments
 (0)