Skip to content

Commit 0e11525

Browse files
committed
Prepare version info and docs for 0.9.0 release.
Add CHANGELOG to aid with release notifications and to highlight important changes in each new version.
1 parent 31b15c3 commit 0e11525

File tree

4 files changed

+109
-2
lines changed

4 files changed

+109
-2
lines changed

CHANGELOG

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
2+
==================
3+
Datatest Changelog
4+
==================
5+
6+
7+
2018-04-29 (0.9.0)
8+
==================
9+
10+
* Added bundled version pytest plugin to base installation.
11+
* Added universal composability for all allowances (using UNION and
12+
INTERSECTION via "|" and "&" operators).
13+
* Added ``allowed`` factory class to simplify allowance imports.
14+
* Changed is_valid() to valid().
15+
* Changed ValidationError to display differences in sorted order.
16+
* Added Python 2 and 3 compatible get_reader() to quickly load
17+
csv.reader-like interface for Unicode CSV, MS Excel, pandas.DataFrame,
18+
DBF, etc.
19+
* Added formal order of operations for allowance resolution.
20+
* Added formal predicate object handling.
21+
* Added Sphinx-tabs style docs for clear separation of pytest and
22+
unittest style examples.
23+
* Changed DataSource to Selector, DataQuery to Query, and DataResult to
24+
Result.
25+
26+
27+
2017-11-26 (0.8.3)
28+
==================
29+
30+
* Added module-level functions: validate() and is_valid().
31+
* Changed DataQuery selections now default to a list type when no
32+
outer-container is specified.
33+
* Added DataQuery.apply() method for group-wise function application.
34+
* Changed ValidationError repr to print a trailing comma with the last item
35+
(for ease of copy-and-paste work flow).
36+
* Changed sequence validation behavior provides more precise differences.
37+
* Added truncation support for ValidationErrors with long lists of differences.
38+
* Changed excess differences in allowed_specific() definitions no longer
39+
trigger test failures.
40+
* Added support for user-defined functions to narrow DataSource selections.
41+
* Added traceback hiding for pytest.
42+
* Fixed bug in DataQuery.map() method--now converts set types into lists.
43+
44+
45+
2017-06-11 (0.8.2)
46+
==================
47+
48+
* Added Boolean composition for allowed_specific() context manager.
49+
* Added proper __repr__() support to DataSource and DataQuery.
50+
* Changed DataQuery so it fails early if bad "select" syntax is used or if
51+
unknown columns are selected.
52+
* Added __copy__() method to DataQuery.
53+
* Changed parent class of differences so they no longer inherit from Exception
54+
(this confused their intended use).
55+
* Changed documentation structure for ease of reference.
56+
57+
58+
2017-06-11 (0.8.1)
59+
==================
60+
61+
* Changed DataQuery select behavior to fail immediately when invalid syntax is
62+
used (rather than later when attempting to execute the query).
63+
* Changed error messages to better explain what went wrong.
64+
65+
66+
2017-05-30 (0.8.0)
67+
==================
68+
69+
* Added a single, smarter assertValid() method.
70+
* Removed old assertion methods.
71+
* Added query optimization and a simpler and more expressive syntax.
72+
* Changed allowances and errors to be more expressive.
73+
* Added basic composability to some allowance classes using "&" and "|"
74+
bit-wise operators.
75+
76+
77+
2016-08-02 (0.7.0.dev2)
78+
=======================
79+
80+
* Removed some of the internal magic and renames data assertions to more
81+
clearly indicate their intended use.
82+
* Changed data allowances to provide more consistent parameters and more
83+
flexible usage.
84+
* Added new method to assert unique values.
85+
* Added full **fmtparams support for CSV handling.
86+
* Fixed comparison and allowance behavior for None vs. zero.
87+
88+
89+
2016-05-29 (0.6.0.dev1)
90+
=======================
91+
92+
* First public release of rewritten code base.
93+
94+
95+
Changelog Guidelines
96+
====================
97+
98+
* Begin each section with the date--in YYYY-MM-DD format--followed by the
99+
version number in parenthesis.
100+
* The initial bullet-point may provide a one-line description of the release.
101+
* Following bullet-points should begin with "Added", "Changed", "Fixed", or
102+
"Removed" when describing the notable changes.
103+
* Limit lines to 80 character width.

datatest/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@
2727
Query.__module__ = 'datatest'
2828
Result.__module__ = 'datatest'
2929

30-
__version__ = '0.8.4.dev0'
30+
__version__ = '0.9.0'
3131

3232
required = mandatory # Temporary alias for old "required" decorator.

datatest/__past__/api09.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
"""Backward compatibility for version 0.9 API."""
2+
from __future__ import absolute_import
3+
4+
# This is a stub for future use.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
#
6767
# The short X.Y version.
6868
#from datatest import __version__
69-
__version__ = '0.8.4.dev0'
69+
__version__ = '0.9.0'
7070
version = __version__
7171

7272
# The full version, including alpha/beta/rc tags.

0 commit comments

Comments
 (0)