From 873bb0c900f9f2695abc4d1c16f8e2b304a53c47 Mon Sep 17 00:00:00 2001 From: John Evans Date: Thu, 25 Sep 2014 09:12:46 -0400 Subject: [PATCH] housecleaning for 0.7.0 release --- CHANGES.txt | 2 ++ docs/source/conf.py | 4 ++-- docs/source/how_do_i.rst | 18 ++++++++++-------- docs/source/index.rst | 2 +- docs/source/introduction.rst | 5 +++-- docs/source/roadmap.rst | 7 +++++++ docs/source/whatsnew/0.7.rst | 11 +++++++++++ docs/source/whatsnew/index.rst | 1 + glymur/test/fixtures.py | 3 ++- glymur/version.py | 2 +- 10 files changed, 40 insertions(+), 15 deletions(-) create mode 100644 docs/source/whatsnew/0.7.rst diff --git a/CHANGES.txt b/CHANGES.txt index 44d6832..071453c 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,3 +1,5 @@ +Sep 25, 2014 - -v0.7.0 Added __getitem__, __setitem__ support. + Mar 06, 2014 - Added Cinema2K, Cinema4K write support. Changed constructor for ChannelDefinition box. Removed support for Python 2.6. Added write support for JP2 UUID, DataEntryURL, diff --git a/docs/source/conf.py b/docs/source/conf.py index 3e6b26e..5c44e90 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -76,9 +76,9 @@ copyright = u'2013, John Evans' # built documents. # # The short X.Y version. -version = '0.6' +version = '0.7' # The full version, including alpha/beta/rc tags. -release = '0.6.0' +release = '0.7.0rc1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/source/how_do_i.rst b/docs/source/how_do_i.rst index a9da7c1..3e0c3ee 100644 --- a/docs/source/how_do_i.rst +++ b/docs/source/how_do_i.rst @@ -3,11 +3,12 @@ How do I...? ------------ -... read the lower resolution images? -===================================== -Jp2k implements slicing via the :py:meth:`__getitem__` method so -any lower resolution images in a JPEG 2000 file can easily be -accessed, for example here's how to retrieve the first sub-image :: +... read images? +================ +Jp2k implements slicing via the :py:meth:`__getitem__` method, meaning that +multiple resolution imagery in a JPEG 2000 file can +easily be accessed. For example here's how to retrieve a full resolution and +first lower-resolution image :: >>> import glymur >>> jp2file = glymur.data.nemo() @@ -24,15 +25,16 @@ such as quality layers. ... display metadata? ===================== -There are two ways. From the command line, the script **jp2dump** is +There are two ways. From the command line, the console script **jp2dump** is available. :: $ jp2dump /path/to/glymur/installation/data/nemo.jp2 -From within Python, it is as simple as printing the Jp2k object, i.e. :: +From within Python, the same result is obtained simply by printing the Jp2k +object, i.e. :: >>> import glymur - >>> jp2file = glymur.data.nemo() + >>> jp2file = glymur.data.nemo() # just a path to a JP2 file >>> jp2 = glymur.Jp2k(jp2file) >>> print(jp2) File: nemo.jp2 diff --git a/docs/source/index.rst b/docs/source/index.rst index 0675eef..8c1fb03 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,9 +15,9 @@ Contents: introduction detailed_installation how_do_i - api whatsnew/index roadmap + api ------------------ Indices and tables diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index bfe7174..11059fd 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -27,5 +27,6 @@ but you should also be able to install Glymur via pip :: $ pip install glymur -In addition to the package, this also gives you a script **jp2dump** that can -be used from the command line line to print JPEG 2000 metadata. +In addition to the package, this also gives you a command line script +**jp2dump** that can be used from the command line line to print JPEG 2000 +metadata. diff --git a/docs/source/roadmap.rst b/docs/source/roadmap.rst index f0d7017..284c139 100644 --- a/docs/source/roadmap.rst +++ b/docs/source/roadmap.rst @@ -1,3 +1,10 @@ +------------------------------------- +Platforms Tested (0.7.0 release only) +------------------------------------- + * Linux Mint 17 / Python 3.4.0 + * Linux Mint 17 / Python 2.7.6 + * MacOS 10.6.8 / MacPorts / Python 3.4.1 + ------------ Known Issues ------------ diff --git a/docs/source/whatsnew/0.7.rst b/docs/source/whatsnew/0.7.rst new file mode 100644 index 0000000..0a21d9b --- /dev/null +++ b/docs/source/whatsnew/0.7.rst @@ -0,0 +1,11 @@ +===================== +Changes in glymur 0.7 +===================== + +Changes in 0.7.0 +================= + + * implemented :py:meth:`__getitem__`, :py:meth:`__setitem__` support + * added back windows support + * box_id and longname are class attributes now instead of instance + attributes (see issue 248) diff --git a/docs/source/whatsnew/index.rst b/docs/source/whatsnew/index.rst index da7e319..2d69949 100644 --- a/docs/source/whatsnew/index.rst +++ b/docs/source/whatsnew/index.rst @@ -10,3 +10,4 @@ These document the changes between minor (or major) versions of glymur. 0.5 0.6 + 0.7 diff --git a/glymur/test/fixtures.py b/glymur/test/fixtures.py index 98554d6..838756a 100644 --- a/glymur/test/fixtures.py +++ b/glymur/test/fixtures.py @@ -23,7 +23,8 @@ if sys.hexversion < 0x03000000: WARNING_INFRASTRUCTURE_MSG = "3.x warning infrastructure only" elif re.match('1.[0-6]', six.__version__) is not None: WARNING_INFRASTRUCTURE_ISSUE = True - WARNING_INFRASTRUCTURE_MSG = "Cannot use with this version of six" + msg = "Cannot run test with version {0} of python-six" + WARNING_INFRASTRUCTURE_MSG = msg.format(six.__version__) class MetadataBase(unittest.TestCase): """ diff --git a/glymur/version.py b/glymur/version.py index 8ffd80f..43ae3f5 100644 --- a/glymur/version.py +++ b/glymur/version.py @@ -19,7 +19,7 @@ from .lib import openjp2 as opj2 # Do not change the format of this next line! Doing so risks breaking # setup.py -version = "0.6.0" +version = "0.7.0rc1" _sv = LooseVersion(version) version_tuple = _sv.version