Skip to content

Commit 4753db0

Browse files
authored
Merge pull request #221 from joe733/workshop
feat: add pyproject.toml, README.md, upd gitignore
2 parents 66726ef + 667c064 commit 4753db0

File tree

7 files changed

+660
-60
lines changed

7 files changed

+660
-60
lines changed

.gitignore

Lines changed: 149 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,166 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
13
*.py[cod]
4+
*$py.class
25

36
# C extensions
47
*.so
58

6-
# Packages
7-
*.egg
8-
*.egg-info
9-
dist
10-
build
11-
eggs
12-
parts
13-
bin
14-
var
15-
sdist
16-
develop-eggs
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
1725
.installed.cfg
18-
lib
19-
lib64
20-
__pycache__
21-
docs/_build
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
2234

2335
# Installer logs
2436
pip-log.txt
37+
pip-delete-this-directory.txt
2538

2639
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
2743
.coverage
28-
.tox
44+
.coverage.*
45+
.cache
2946
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
3053

3154
# Translations
3255
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
#.idea/
161+
162+
# VSCode
163+
.vscode/
33164

34-
# Mr Developer
35-
.mr.developer.cfg
36-
.project
37-
.pydevproject
165+
# asdf
166+
.tool-versions

.isort.cfg

Lines changed: 0 additions & 6 deletions
This file was deleted.

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# validators - Python Data Validation for Humans™
2+
3+
[![Build Status][bs-badge]][bs-link] [![Version Status][vs-badge]][vs-link] [![Downloads][dw-badge]][dw-link]
4+
5+
Python has all kinds of data validation tools, but every one of them seems to
6+
require defining a schema or form. I wanted to create a simple validation
7+
library where validating a simple value does not require defining a form or a
8+
schema.
9+
10+
```py
11+
>>> import validators
12+
13+
>>> validators.email('[email protected]')
14+
True
15+
```
16+
17+
## Resources
18+
19+
- [Documentation](https://validators.readthedocs.io/)
20+
- [Issue Tracker](http://github.com/kvesteri/validators/issues)
21+
- [Code](http://github.com/kvesteri/validators/)
22+
23+
[bs-badge]: https://github.com/kvesteri/validators/workflows/GH/badge.svg
24+
[bs-link]: https://github.com/kvesteri/validators/actions/workflows/main.yml
25+
[vs-badge]: https://img.shields.io/pypi/v/validators.svg
26+
[vs-link]: https://pypi.python.org/pypi/validators/
27+
[dw-badge]: https://img.shields.io/pypi/dm/validators.svg
28+
[dw-link]: https://pypi.python.org/pypi/validators/

0 commit comments

Comments
 (0)