Merge branch 'release/v1.0.0'

Author: michaelherold

.coveragerc

@@ -0,0 +1,3 @@
+[run]
+omit = *test*
+source = pyisemail

.gitignore

@@ -1 +1,28 @@
-
+*.py[cod]
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+htmlcov
+
+.idea
+.pypirc

.travis.yml

@@ -0,0 +1,15 @@
+language: python
+python:
+  - 2.7
+  - 3.3
+  - pypy
+install:
+  - if [[ $TRAVIS_PYTHON_VERSION == 2* ]]; then pip install -r requirements-py2.txt --use-mirrors; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == 3* ]]; then pip install -r requirements-py3.txt --use-mirrors; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == pypy ]]; then pip install -r requirements-py2.txt --use-mirrors; fi
+  - pip install -r requirements.txt --use-mirrors
+  - pip install coveralls --use-mirrors
+script:
+  - coverage run setup.py -q test
+after_success:
+  - coveralls

.venv

@@ -1,25 +1,19 @@
-Copyright � 2012, Michael Herold
-All rights reserved.
+Copyright (c) 2013, Michael Herold
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-    - Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-    - Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-    - Neither the name of Michael Herold nor the names of its contributors may
-      be used to endorse or promote products derived from this software without
-      specific prior written permission.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

LICENSE

@@ -0,0 +1,116 @@
+# pyIsEmail
+
+[![Version](https://pypip.in/v/pyIsEmail/badge.png)][crate]
+[![Travis](https://travis-ci.org/michaelherold/pyIsEmail.png?branch=master)][travis]
+[![Coverage](https://coveralls.io/repos/michaelherold/pyIsEmail/badge.png?branch=master)][coveralls]
+
+[crate]: https://crate.io/package/pyIsEmail
+[travis]: http://travis-ci.org/michaelherold/pyIsEmail
+[coveralls]: https://coveralls.io/r/michaelherold/pyIsEmail
+
+## Getting Started
+
+pyIsEmail is a no-nonsense approach for checking whether that user-supplied
+email address could be real. Sick of not being able to use
+[email address tagging][tagging] to sort through your [Bacn][bacn]? We can fix
+that.
+
+Regular expressions are cheap to write, but often require maintenance when new
+top-level domains come out or don't conform to email addressing features that
+come back into vogue. pyIsEmail allows you to validate an email address -- and
+even check the domain, if you wish -- with one simple call, making your code
+more readable and faster to write. When you want to know why an email address
+doesn't validate, we even provide you with a diagnosis.
+
+[tagging]: http://en.wikipedia.org/wiki/Email_address#Address_tags
+[bacn]: http://en.wikipedia.org/wiki/Bacn
+
+## Install
+
+Install from PyPI using [pip], a package manager for Python.
+
+    $ pip install pyIsEmail
+
+Don't have pip installed? Try installing it, by running this from the command
+line:
+
+    $ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python
+
+Or, you can [download the source code (zip)][zipball] for ``pyIsEmail``, and
+then run:
+
+    $ python setup.py install
+
+You may need to run the above commands with ``sudo``.
+
+[pip]: http://www.pip-installer.org/en/latest/
+[zipball]: https://github.com/michaelherold/pyIsEmail/zipball/develop
+
+## Usage
+
+For the simplest usage, import and use the ``is_email`` function:
+
+```python
+
+from pyisemail import is_email
+
+address = "test@example.com"
+bool_result = is_email(address)
+detailed_result = is_email(address, diagnose=True)
+```
+
+You can also check whether the domain used in the email is a valid domain and
+whether or not it has a valid MX record:
+
+```python
+
+from pyisemail import is_email
+
+address = "test@example.com"
+bool_result_with_dns = is_email(address, check_dns=True)
+detailed_result_with_dns = is_email(address, check_dns=True, diagnose=True)
+```
+
+These are primary indicators of whether an email address can even be issued at
+that domain. However, a valid response here *is not a guarantee that the email
+exists*, merely that is *can* exist.
+
+In addition to the base ``is_email`` functionality, you can also use the
+validators by themselves. Check the validator source code to see how this works.
+
+## Uninstall
+
+Want to get rid of pyIsEmail? Did you install with pip? Here you go:
+
+    $ pip uninstall pyIsEmail
+
+## Acknowledgments
+
+The base ``ParserValidator`` is based off of [Dominic Sayers][dominic]'
+[is_email script][is_email]. I wanted the functionality in Python, so I ported
+it from the original PHP.
+
+[dominic]: https://github.com/dominicsayers
+[is_email]: https://github.com/dominicsayers/isemail
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (``git checkout -b my-new-feature``)
+3. Commit your changes (``git commit -am 'Add some feature'``)
+4. Push to the branch (``git push origin my-new-feature``)
+5. Create new Pull Request
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs.
+
+[semver]: http://semver.org/
+
+## Copyright
+
+Copyright (c) 2013 Michael Herold. Open sourced under the terms of the
+[MIT license][license].
+
+[license]: http://opensource.org/licenses/MIT