From 452434a81a09b4e514a7e2110e84612a18fda1e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A1szl=C3=B3=20K=C3=A1rolyi?= Date: Sat, 2 Mar 2019 03:26:58 +0100 Subject: [PATCH] Fix documentation --- README.rst | 19 +++++++++++-------- setup.py | 1 + 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 02282d1..ee07202 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,16 @@ .. image:: https://travis-ci.org/karolyi/py3-validate-email.svg?branch=master :target: https://travis-ci.org/karolyi/py3-validate-email -============== +============================ py3-validate-email -============== +============================ py3-validate-email is a package for Python that check if an email is valid, properly formatted and really exists. This module is for Python 3.6 and above! INSTALLATION -============ +============================ You can install the package with pip: @@ -18,17 +18,20 @@ You can install the package with pip: USAGE -===== +============================ Basic usage:: from validate_email import validate_email - is_valid = validate_email('example@example.com', check_regex=True, check_mx=True) + is_valid = validate_email(email_address='example@example.com', check_regex=True, check_mx=True, from_address='my@from.addr.ess', smtp_timeout=10, use_blacklist=True) -check_regex will check will the email address has a valid structure and defaults to True -check_mx will check the mx-records and check whether the email actually exists +`check_regex` will check will the email address has a valid structure and defaults to True +`check_mx`: check the mx-records and check whether the email actually exists +`from_address`: the email address the probe will be sent from, +`smtp_timeout`: seconds until SMTP timeout +`use_blacklist`: use the blacklist of domains downloaded from [https://githubusercontent.com/martenson/disposable-email-domains](https://raw.githubusercontent.com/martenson/disposable-email-domains) TODOs and BUGS -============== +============================ See: https://github.com/karolyi/py3-validate-email/issues diff --git a/setup.py b/setup.py index 14067a1..b198288 100644 --- a/setup.py +++ b/setup.py @@ -33,6 +33,7 @@ setup( author_email='laszlo@karolyi.hu', description='Email validator with regex and SMTP checking.', long_description=open('README.rst').read(), + long_description_content_type='text/x-rst', keywords='email validation verification mx verify', url='http://github.com/karolyi/py3-validate-email', cmdclass=dict(build_py=PostBuildPyCommand),