jyapayne/glymur
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

remove test requirement for six, doc modifications, doctest fix

Browse source 
The test requirement for six was problematic, as some versions cause
problems with assertWarns and some do not.  We are already filtering
out versions that we know cause problems and it can unintentionally
cause an upgrade superceding the system version if it remains as a
"test_requires" option, so best to get rid of it.  Additionally, the
"test_requires" option was entirely removed as pip doesn't recognize it
upon install, so "mock" would not be installed on Python2.7 via pip.

The doctest fix was the real fix for #316, not sure why this did
not show up when testing on linux mint
This commit is contained in:
John Evans 2015-01-08 15:30:10 -05:00 • committed by jevans
commit 2ffdf716c0
9 changed files with 33 additions and 130 deletions
Download patch file Download diff file Expand all files Collapse all files

5
CHANGES.txt
View file

@ -1,3 +1,8 @@
Jan 08, 2015 - v0.8.0rc1 Reduced number of steps required for
writing images. Deprecated old read and write methods in favor
of array-style slicing. Added ignore_pclr_cmap_cdef, verbose,
shape, codestream, layer properties.
Oct 06, 2014 - v0.7.2 Added ellipsis support in array-style slicing.
Oct 02, 2014 - v0.7.1 Fixed README to mention Python 3.4

116
docs/source/api.rst
View file

@ -1,116 +0,0 @@
---
API
---
Jp2k
----
.. autoclass:: glymur.Jp2k
:members: read, write, wrap, read_bands, get_codestream
Individual Boxes
----------------
Jp2kbox
'''''''
.. autoclass:: glymur.jp2box.Jp2kBox
:members:
AssociationBox
''''''''''''''
.. autoclass:: glymur.jp2box.AssociationBox
:members:
ColourSpecificationBox
''''''''''''''''''''''
.. autoclass:: glymur.jp2box.ColourSpecificationBox
:members:
ChannelDefinitionBox
''''''''''''''''''''''
.. autoclass:: glymur.jp2box.ChannelDefinitionBox
:members:
ComponentMappingBox
'''''''''''''''''''
.. autoclass:: glymur.jp2box.ComponentMappingBox
:members:
ContiguousCodestreamBox
'''''''''''''''''''''''
.. autoclass:: glymur.jp2box.ContiguousCodestreamBox
:members:
DataEntryURLBox
'''''''''''''''
.. autoclass:: glymur.jp2box.DataEntryURLBox
:members:
FileTypeBox
'''''''''''
.. autoclass:: glymur.jp2box.FileTypeBox
:members:
ImageHeaderBox
''''''''''''''
.. autoclass:: glymur.jp2box.ImageHeaderBox
:members:
JP2HeaderBox
''''''''''''
.. autoclass:: glymur.jp2box.JP2HeaderBox
:members:
JPEG2000SignatureBox
''''''''''''''''''''
.. autoclass:: glymur.jp2box.JPEG2000SignatureBox
:members:
LabelBox
''''''''
.. autoclass:: glymur.jp2box.LabelBox
:members:
PaletteBox
''''''''''
.. autoclass:: glymur.jp2box.PaletteBox
:members:
ReaderRequirementsBox
'''''''''''''''''''''
.. autoclass:: glymur.jp2box.ReaderRequirementsBox
:members:
ResolutionBox
'''''''''''''
.. autoclass:: glymur.jp2box.ResolutionBox
:members:
CaptureResolutionBox
''''''''''''''''''''
.. autoclass:: glymur.jp2box.CaptureResolutionBox
:members:
DisplayResolutionBox
''''''''''''''''''''
.. autoclass:: glymur.jp2box.DisplayResolutionBox
:members:
UUIDBox
'''''''
.. autoclass:: glymur.jp2box.UUIDBox
:members:
UUIDInfoBox
'''''''''''
.. autoclass:: glymur.jp2box.UUIDInfoBox
:members:
UUIDListBox
'''''''''''
.. autoclass:: glymur.jp2box.UUIDListBox
:members:
XMLBox
''''''
.. autoclass:: glymur.jp2box.XMLBox
:members:

4
docs/source/conf.py
View file

@ -75,9 +75,9 @@ copyright = u'2013, John Evans'
# built documents.
#
# The short X.Y version.
version = '0.7'
version = '0.8'
# The full version, including alpha/beta/rc tags.
release = '0.7.2'
release = '0.8.0rc2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

8
docs/source/how_do_i.rst
View file

@ -26,10 +26,10 @@ It's pretty simple, just supply the image data as the 2nd argument to the Jp2k
constructor.
>>> import glymur, numpy as np
>>> data = np.zeros((640, 480), dtype=np.uint8)
>>> jp2 = glymur.Jp2k('zeros.jp2', data=data)
>>> jp2 = glymur.Jp2k('zeros.jp2', data=np.zeros((640, 480), dtype=np.uint8)
You should have OpenJPEG version 1.5 or more recent before writing JPEG 2000 images.
You must have OpenJPEG version 1.5 or more recent in order to write JPEG 2000
images with glymur.
... display metadata?
=====================
@ -442,7 +442,7 @@ following
'Google'
But that would be painful. A better solution is to install the Python XMP
Toolkit (make sure it is version 2.0)::
Toolkit (make sure it is at least version 2.0)::
>>> from libxmp import XMPMeta
>>> from libxmp.consts import XMP_NS_XMP as NS_XAP

1
docs/source/index.rst
View file

@ -17,7 +17,6 @@ Contents:
how_do_i
whatsnew/index
roadmap
api
------------------
Indices and tables

16
docs/source/whatsnew/0.8.rst
View file

@ -7,6 +7,18 @@ Changes in 0.8.0
* Simplified writing images by moving data and options into the
constructor.
* The main_header attribute of the ContiguousCodestream class is now called
codestream.
* Deprecated :py:meth:`read` method in favor of array-style slicing.
In order to retain certain functionality, the following parameters
to the :py:meth:`read` method have become top-level properties
* verbose
* layer
* ignore_pclr_cmap_cdef
* Two additional properties were introduced.
* codestream
* shape

7
glymur/test/test_jp2box.py
View file

@ -27,12 +27,17 @@ from .fixtures import (WARNING_INFRASTRUCTURE_ISSUE,
WINDOWS_TMP_FILE_MSG, MetadataBase)
def docTearDown(doctest_obj):
glymur.set_parseoptions(full_codestream=False)
def load_tests(loader, tests, ignore):
"""Run doc tests as well."""
if os.name == "nt":
# Can't do it on windows, temporary file issue.
return tests
tests.addTests(doctest.DocTestSuite('glymur.jp2box'))
tests.addTests(doctest.DocTestSuite('glymur.jp2box',
tearDown=docTearDown))
return tests

2
glymur/version.py
View file

@ -18,7 +18,7 @@ from .lib import openjpeg as opj, openjp2 as opj2
# Do not change the format of this next line! Doing so risks breaking
# setup.py
version = "0.7.2"
version = "0.8.0rc2"
_sv = LooseVersion(version)
version_tuple = _sv.version

4
setup.py
View file

@ -21,12 +21,10 @@ kwargs = {'name': 'Glymur',
'test_suite': 'glymur.test'}
install_requires = ['numpy>=1.7.0', 'lxml>=3.0.0']
test_requires = ['six>=1.7.0']
if sys.hexversion < 0x03030000:
install_requires.append('contextlib2>=0.4')
test_requires.append('mock>=1.0.1')
install_requires.append('mock>=1.0.1')
kwargs['install_requires'] = install_requires
kwargs['test_requires'] = test_requires
clssfrs = ["Programming Language :: Python",
"Programming Language :: Python :: 2.7",