Skip to content

Commit f728d88

Browse files
JoshDataJoshData
committed
Make a CHANGELOG file
1 parent 37052e0 commit f728d88

File tree

2 files changed

+106
-20
lines changed

2 files changed

+106
-20
lines changed

Diff for: ‎CHANGELOG.md

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
Unreleased changes in development
2+
---------------------------------
3+
4+
* Deliverability checks now check for 'v=spf1 -all' SPF records as a way to reject more bad domains.
5+
* Special use domain names now raise EmailSyntaxError instead of EmailUndeliverableError since they are performed even if check_deliverability is off.
6+
* New module-level attributes are added to override the default values of the keyword arguments and the special-use domains list.
7+
* The keyword arguments of the public methods are now marked as keyword-only.
8+
* [pyIsEmail](https://github.com/michaelherold/pyIsEmail)'s test cases are added to the tests.
9+
* Recommend that check_deliverability be set to False for validation on login pages.
10+
11+
Version 1.2.1 (May 1, 2022)
12+
---------------------------
13+
14+
* example.com/net/org are removed from the special-use reserved domain names list so that they do not raise exceptions if check_deliverability is off.
15+
* Improved README.
16+
17+
Verison 1.2.0 (April 24, 2022)
18+
------------------------------
19+
20+
* Reject domains with NULL MX records (when deliverability checks
21+
are turned on).
22+
* Reject unsafe unicode characters. (Some of these checks you should
23+
be doing on all of your user inputs already!)
24+
* Reject most special-use reserved domain names with EmailUndeliverableError. A new `test_environment` option is added for using `@*.test` domains.
25+
* Improved safety of exception text by not repeating an unsafe input character in the message.
26+
* Minor fixes in tests.
27+
* Invoking the module as a standalone program now caches DNS queries.
28+
* Improved README.
29+
30+
Version 1.1.3 (June 12, 2021)
31+
-----------------------------
32+
33+
* Allow passing a custom dns_resolver so that a DNS cache and a custom timeout can be set.
34+
35+
Version 1.1.2 (Nov 5, 2020)
36+
---------------------------
37+
38+
* Fix invoking the module as a standalone program.
39+
* Fix deprecation warning in Python 3.8.
40+
* Code improvements.
41+
* Improved README.
42+
43+
Version 1.1.1 (May 19, 2020)
44+
----------------------------
45+
46+
* Fix exception when DNS queries time-out.
47+
* Improved README.
48+
49+
Version 1.1.0 (Spril 30, 2020)
50+
------------------------------
51+
52+
* The main function now returns an object with attributes rather than a dict with keys, but accessing the object in the old way is still supported.
53+
* Added overall email address length checks.
54+
* Minor tweak to regular expressions.
55+
* Improved error messages.
56+
* Added tests.
57+
* Linted source code files; changed README to Markdown.
58+
59+
Version 1.0.5 (Oct 18, 2019)
60+
----------------------------
61+
62+
* Prevent resolving domain names as if they were not fully qualified using a local search domain settings.
63+
64+
Version 1.0.4 (May 2, 2019)
65+
---------------------------
66+
67+
* Added a timeout argument for DNS queries.
68+
* The wheel distribution is now a universal wheel.
69+
* Improved README.
70+
71+
Version 1.0.3 (Sept 12, 2017)
72+
-----------------------------
73+
74+
* Added a wheel distribution for easier installation.
75+
76+
Version 1.0.2 (Dec 30, 2016)
77+
----------------------------
78+
79+
* Fix dnspython package name in Python 3.
80+
* Improved README.
81+
82+
Version 1.0.1 (March 6, 2016)
83+
-----------------------------
84+
85+
* Fixed minor errors.
86+
87+
Version 1.0.0 (Sept 5, 2015)
88+
----------------------------
89+
90+
* Fail domains with a leading period.
91+
* Improved error messages.
92+
* Added tests.
93+
94+
Version 0.5.0 (June 15, 2015)
95+
-----------------------------
96+
97+
* Use IDNA 2008 instead of IDNA 2003 and use the idna package's UTS46 normalization instead of our own.
98+
* Fixes for Python 2.
99+
* Improved error messages.
100+
* Improved README.
101+
102+
Version 0.1.0 (April 21, 2015)
103+
------------------------------
104+
105+
Initial release!

Diff for: ‎README.md

+1-20
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,7 @@ This library is tested with Python 3.6+ but should work in earlier versions:
3131

3232
[![Build Status](https://app.travis-ci.com/JoshData/python-email-validator.svg?branch=main)](https://app.travis-ci.com/JoshData/python-email-validator)
3333

34-
---
35-
36-
This library was first published in 2015. The current version is 1.2.1
37-
(posted May 1, 2022). The main changes in version 1.2 are:
38-
39-
* Rejecting domains with NULL MX records (when deliverability checks
40-
are turned on).
41-
* Rejecting unsafe unicode characters. (Some of these checks you should
42-
be doing on all of your user inputs already!)
43-
* Rejecting most special-use reserved domain names. A new `test_environment`
44-
option is added for using `@*.test` domains.
45-
* Some fixes in the tests.
46-
47-
Unreleased changes in development:
48-
49-
* Deliverability checks now check for 'v=spf1 -all' SPF records as a way to reject more bad domains.
50-
* Special use domain names now raise EmailSyntaxError instead of EmailUndeliverableError.
51-
* New module-level attributes are added to override the default values of the keyword arguments and the special-use domains list.
52-
* The keyword arguments of the public methods are now marked as keyword-only.
53-
* [pyIsEmail](https://github.com/michaelherold/pyIsEmail)'s test cases are added to the tests.
34+
[CHANGELOG / Release Notes](CHANGELOG.md)
5435

5536
---
5637

0 commit comments

Comments
 (0)