jpylyzer 2.2.1__tar.gz → 2.3.0b2__tar.gz

{jpylyzer-2.2.1 → jpylyzer-2.3.0b2}/PKG-INFO

@@ -1,22 +1,37 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: jpylyzer
-Version: 2.2.1
+Version: 2.3.0b2
 Summary: JP2 (JPEG 2000 Part 1) image validator and properties extractor
 Home-page: http://jpylyzer.openpreservation.org/
+Download-URL: https://github.com/openpreserve/jpylyzer/archive/2.3.0b2.tar.gz
 Author: Johan van der Knijff
 Author-email: johan.vanderknijff@kb.nl
 Maintainer: Johan van der Knijff
 Maintainer-email: johan.vanderknijff@kb.nl
 License: LGPL
-Download-URL: https://github.com/openpreserve/jpylyzer/archive/2.2.1.tar.gz
 Platform: POSIX
 Platform: Windows
 Classifier: Environment :: Console
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.2, <4
 Description-Content-Type: text/markdown
-Provides-Extra: testing
 License-File: LICENSE
+Requires-Dist: setuptools
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: platform
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # jpylyzer
 
@@ -35,8 +50,8 @@ Please visit the jpylyzer homepage for links to the most recent package download
 - [![Build Status](https://app.travis-ci.com/openpreserve/jpylyzer.svg?branch=master)](https://app.travis-ci.com/github/openpreserve/jpylyzer "Jpylyzer Travis-CI integration build") Travis-CI
 
 - [![Build Status](https://jenkins.openpreservation.org/buildStatus/icon?job=jpylyzer%2Fjpylyzer)](https://jenkins.openpreservation.org/job/jpylyzer/job/jpylyzer/) OPF Jenkins
-<!-- Start of text to be copied to usage.md of jpylyzer website -->
 
+<!-- Start of text to be copied to usage.md of jpylyzer website -->
 ## Using jpylyzer from the command line
 
 Calling *jpylyzer* in a command window without any arguments results in the following helper message:
@@ -130,11 +145,18 @@ validation process (organised by box)
 
 Instead of using *jpylyzer* from the command-line, you can also import
 it as a module in your own Python programs. To do so, install jpylyzer
-with *pip*. Then import *jpylyzer* into your code by adding:
+with *pip* in a virtual environment:
+
+```
+pip install jpylyzer
+```
+
+Then import *jpylyzer* into your code by adding:
 
 ```python
 from jpylyzer import jpylyzer
 ```
+
 Subsequently you can call any function that is defined in *jpylyzer.py*.
 In practice you will most likely only need the *checkOneFile* function.
 The following minimal script shows how this works:
@@ -171,8 +193,29 @@ myResult = jpylyzer.checkOneFile(myFile, 'j2c')
 
 <!-- End of text to be copied to usage.md of jpylyzer website -->
 
-## Steps in preparing a jpylyzer release
+## Validator modules and classes
+
+As of Jpylyzer 2.3, the validator functions are spread across 6 modules, each of which contains a validator class.
+These validator classes are all child classes of the "Validator" base class that is defined in [validator.py](./jpylyzer/validator.py):
+
+- [jp2.py](./jpylyzer/jp2.py) - Top-level JP2 / JPH validation (class *JP2Validator*)
+- [boxes.py](./jpylyzer/boxes.py) - Validation of all defined boxes for JP2 and JPH (class *BoxValidator*)
+- [codestream.py](./jpylyzer/codestream.py) - JPEG 2000 codestream validation (class *CSValidator*)
+- [tilepart.py](./jpylyzer/tilepart.py) - Validation of one tile part of a JPEG 2000 codestream (class *TilePartValidator*)
+- [csmarkers.py](./jpylyzer/csmarkers.py) - Validation of JPEG 2000 codestream marker segments (class *CSMarkerValidator*)
+- [icc.py](./jpylyzer/icc.py) - Feature extraction from an ICC profile (class *IccValidator*)
 
-[See instructions here](./howto-prepare-release.md)
+The table below shows how each higher-level classe imports all classes that are needed for validation at the underlying level:
 
+|Validator class|Imported validator classes|
+|:--|:--|
+|JP2Validator|BoxValidator|
+|BoxValidator|CSValidator, IccValidator|
+|CSValidator|TilePartValidator, CSMarkerValidator|
+|TilePartValidator|CSMarkerValidator|
+|CSMarkerValidator|-|
+|IccValidator|-|
+
+## Steps in preparing a jpylyzer release
 
+[See instructions here](./readme-how-prepare-release.md)

jpylyzer-2.2.1/jpylyzer.egg-info/PKG-INFO → jpylyzer-2.3.0b2/README.md

@@ -1,23 +1,3 @@
-Metadata-Version: 2.1
-Name: jpylyzer
-Version: 2.2.1
-Summary: JP2 (JPEG 2000 Part 1) image validator and properties extractor
-Home-page: http://jpylyzer.openpreservation.org/
-Author: Johan van der Knijff
-Author-email: johan.vanderknijff@kb.nl
-Maintainer: Johan van der Knijff
-Maintainer-email: johan.vanderknijff@kb.nl
-License: LGPL
-Download-URL: https://github.com/openpreserve/jpylyzer/archive/2.2.1.tar.gz
-Platform: POSIX
-Platform: Windows
-Classifier: Environment :: Console
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.2, <4
-Description-Content-Type: text/markdown
-Provides-Extra: testing
-License-File: LICENSE
-
 # jpylyzer
 
 ## About
@@ -35,8 +15,8 @@ Please visit the jpylyzer homepage for links to the most recent package download
 - [![Build Status](https://app.travis-ci.com/openpreserve/jpylyzer.svg?branch=master)](https://app.travis-ci.com/github/openpreserve/jpylyzer "Jpylyzer Travis-CI integration build") Travis-CI
 
 - [![Build Status](https://jenkins.openpreservation.org/buildStatus/icon?job=jpylyzer%2Fjpylyzer)](https://jenkins.openpreservation.org/job/jpylyzer/job/jpylyzer/) OPF Jenkins
-<!-- Start of text to be copied to usage.md of jpylyzer website -->
 
+<!-- Start of text to be copied to usage.md of jpylyzer website -->
 ## Using jpylyzer from the command line
 
 Calling *jpylyzer* in a command window without any arguments results in the following helper message:
@@ -130,11 +110,18 @@ validation process (organised by box)
 
 Instead of using *jpylyzer* from the command-line, you can also import
 it as a module in your own Python programs. To do so, install jpylyzer
-with *pip*. Then import *jpylyzer* into your code by adding:
+with *pip* in a virtual environment:
+
+```
+pip install jpylyzer
+```
+
+Then import *jpylyzer* into your code by adding:
 
 ```python
 from jpylyzer import jpylyzer
 ```
+
 Subsequently you can call any function that is defined in *jpylyzer.py*.
 In practice you will most likely only need the *checkOneFile* function.
 The following minimal script shows how this works:
@@ -171,8 +158,29 @@ myResult = jpylyzer.checkOneFile(myFile, 'j2c')
 
 <!-- End of text to be copied to usage.md of jpylyzer website -->
 
-## Steps in preparing a jpylyzer release
+## Validator modules and classes
+
+As of Jpylyzer 2.3, the validator functions are spread across 6 modules, each of which contains a validator class.
+These validator classes are all child classes of the "Validator" base class that is defined in [validator.py](./jpylyzer/validator.py):
+
+- [jp2.py](./jpylyzer/jp2.py) - Top-level JP2 / JPH validation (class *JP2Validator*)
+- [boxes.py](./jpylyzer/boxes.py) - Validation of all defined boxes for JP2 and JPH (class *BoxValidator*)
+- [codestream.py](./jpylyzer/codestream.py) - JPEG 2000 codestream validation (class *CSValidator*)
+- [tilepart.py](./jpylyzer/tilepart.py) - Validation of one tile part of a JPEG 2000 codestream (class *TilePartValidator*)
+- [csmarkers.py](./jpylyzer/csmarkers.py) - Validation of JPEG 2000 codestream marker segments (class *CSMarkerValidator*)
+- [icc.py](./jpylyzer/icc.py) - Feature extraction from an ICC profile (class *IccValidator*)
 
-[See instructions here](./howto-prepare-release.md)
+The table below shows how each higher-level classe imports all classes that are needed for validation at the underlying level:
 
+|Validator class|Imported validator classes|
+|:--|:--|
+|JP2Validator|BoxValidator|
+|BoxValidator|CSValidator, IccValidator|
+|CSValidator|TilePartValidator, CSMarkerValidator|
+|TilePartValidator|CSMarkerValidator|
+|CSMarkerValidator|-|
+|IccValidator|-|
+
+## Steps in preparing a jpylyzer release
 
+[See instructions here](./readme-how-prepare-release.md)