moved files for nicer python package structure

RalphTro · Mar 23, 2020 · 5663273 · 5663273
1 parent f18a91d
commit 5663273
Show file tree

Hide file tree

Showing 50 changed files with 55 additions and 15 deletions.
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
@@ -19,19 +19,18 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        cd src
         python -m pip install --upgrade pip
         pip install -r requirements.txt
     - name: Lint with flake8
       run: |
-        cd src
+        cd epcis_event_hash_generator
         pip install flake8
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
       run: |
-        cd src
+        cd tests
         pip install pytest
         pytest
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 This is a proposal/reference implementation for a method to uniquely identify an EPCIS event or validate the integrity thereof. To this end, a syntax-/representation-agnostic approach based on hashing is developed.
 The <b>PROTOTYPAL DEMO SOFTWARE</b> takes an EPCIS Document (either formatted in XML or JSON-LD) and returns the hash value(s) of the contained EPCIS events representing a unique fingerprint of the latter. 
 
-<img src="epcisEventHashGenerator.jpg">
+![EPCIS event hash generator algorithm illustration](docs/epcisEventHashGenerator.jpg)
 
 
 ## Usage (for the inconvenient)
@@ -238,10 +238,7 @@ ni:///sha-512;daef4953b9783365cad6615223720506cc46c5167cd16ab500fa597aa08ff964<b
 
 For better understanding, the following illustration includes the data content of a simple EPCIS event (including a couple of user extensions - all defined under 'https://ns.example.com/epcis'), shows the corresponding pre-hash string as well as the canonical hash value of that event.
 
-<img src="hashingAlgorithmLogicIllustration.jpg">
-
-## Installation
-tbd
+![Example EPCIS event pre-hash computation](docs/hashingAlgorithmLogicIllustration.jpg)
 
 ## References
 * EPCIS Standard, v. 1.2: https://www.gs1.org/standards/epcis

diff --git a/epcis-hash-flow.png → docs/epcis-hash-flow.png b/epcis-hash-flow.png → docs/epcis-hash-flow.png
diff --git a/epcisEventHashGenerator.jpg → docs/epcisEventHashGenerator.jpg b/epcisEventHashGenerator.jpg → docs/epcisEventHashGenerator.jpg
diff --git a/hashingAlgorithmLogicIllustration.jpg → docs/hashingAlgorithmLogicIllustration.jpg b/hashingAlgorithmLogicIllustration.jpg → docs/hashingAlgorithmLogicIllustration.jpg
diff --git a/src/__init__.py → epcis_event_hash_generator/__init__.py b/src/__init__.py → epcis_event_hash_generator/__init__.py
diff --git a/src/disable_test_annotation.py → ...hash_generator/disable_test_annotation.py b/src/disable_test_annotation.py → ...hash_generator/disable_test_annotation.py
diff --git a/src/epcis_event_hash_generator.py → ...h_generator/epcis_event_hash_generator.py b/src/epcis_event_hash_generator.py → ...h_generator/epcis_event_hash_generator.py
diff --git a/src/json_to_py.py → epcis_event_hash_generator/json_to_py.py b/src/json_to_py.py → epcis_event_hash_generator/json_to_py.py
diff --git a/epcis_event_hash_generator/setup.py b/epcis_event_hash_generator/setup.py
@@ -0,0 +1,22 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="epcis-event-hash-generator",
+    version="1.0.1",
+    author=" Ralph Troeger; Sebastian Schmittner",
+    author_email="ralph.troeger@gs1.de;schmittner@eecc.info",
+    description="Exemplary implementation of the epcis event hash generator algorithm described in the README",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/RalphTro/epcis-event-hash-generator",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.6',
+)
diff --git a/src/xml_to_py.py → epcis_event_hash_generator/xml_to_py.py b/src/xml_to_py.py → epcis_event_hash_generator/xml_to_py.py
diff --git a/src/requirements.txt → requirements.txt b/src/requirements.txt → requirements.txt
diff --git a/tests/context.py b/tests/context.py
@@ -0,0 +1,5 @@
+import os
+import sys
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
+import epcis_event_hash_generator
diff --git a/...amples/ReferenceEventHashAlgorithm.hashes → ...amples/ReferenceEventHashAlgorithm.hashes b/...amples/ReferenceEventHashAlgorithm.hashes → ...amples/ReferenceEventHashAlgorithm.hashes
diff --git a/...examples/ReferenceEventHashAlgorithm.json → ...examples/ReferenceEventHashAlgorithm.json b/...examples/ReferenceEventHashAlgorithm.json → ...examples/ReferenceEventHashAlgorithm.json
diff --git a/...les/ReferenceEventHashAlgorithm.prehashes → ...les/ReferenceEventHashAlgorithm.prehashes b/...les/ReferenceEventHashAlgorithm.prehashes → ...les/ReferenceEventHashAlgorithm.prehashes
diff --git a/.../examples/ReferenceEventHashAlgorithm.xml → .../examples/ReferenceEventHashAlgorithm.xml b/.../examples/ReferenceEventHashAlgorithm.xml → .../examples/ReferenceEventHashAlgorithm.xml
diff --git a/...With2DifferentTransformationEvents.hashes → ...With2DifferentTransformationEvents.hashes b/...With2DifferentTransformationEvents.hashes → ...With2DifferentTransformationEvents.hashes
diff --git a/...h2DifferentTransformationEvents.prehashes → ...h2DifferentTransformationEvents.prehashes b/...h2DifferentTransformationEvents.prehashes → ...h2DifferentTransformationEvents.prehashes
diff --git a/...DocWith2DifferentTransformationEvents.xml → ...DocWith2DifferentTransformationEvents.xml b/...DocWith2DifferentTransformationEvents.xml → ...DocWith2DifferentTransformationEvents.xml
diff --git a/.../epcisDocWithSensorDataObjectEvent.hashes → .../epcisDocWithSensorDataObjectEvent.hashes b/.../epcisDocWithSensorDataObjectEvent.hashes → .../epcisDocWithSensorDataObjectEvent.hashes
diff --git a/...es/epcisDocWithSensorDataObjectEvent.json → ...es/epcisDocWithSensorDataObjectEvent.json b/...es/epcisDocWithSensorDataObjectEvent.json → ...es/epcisDocWithSensorDataObjectEvent.json
diff --git a/...cisDocWithSensorDataObjectEvent.prehashes → ...cisDocWithSensorDataObjectEvent.prehashes b/...cisDocWithSensorDataObjectEvent.prehashes → ...cisDocWithSensorDataObjectEvent.prehashes
diff --git a/...les/epcisDocWithSensorDataObjectEvent.xml → ...les/epcisDocWithSensorDataObjectEvent.xml b/...les/epcisDocWithSensorDataObjectEvent.xml → ...les/epcisDocWithSensorDataObjectEvent.xml
diff --git a/...ocWithShippingAndTransportingEvent.hashes → ...ocWithShippingAndTransportingEvent.hashes b/...ocWithShippingAndTransportingEvent.hashes → ...ocWithShippingAndTransportingEvent.hashes
diff --git a/...sDocWithShippingAndTransportingEvent.json → ...sDocWithShippingAndTransportingEvent.json b/...sDocWithShippingAndTransportingEvent.json → ...sDocWithShippingAndTransportingEvent.json
diff --git a/...ithShippingAndTransportingEvent.prehashes → ...ithShippingAndTransportingEvent.prehashes b/...ithShippingAndTransportingEvent.prehashes → ...ithShippingAndTransportingEvent.prehashes
diff --git a/...isDocWithShippingAndTransportingEvent.xml → ...isDocWithShippingAndTransportingEvent.xml b/...isDocWithShippingAndTransportingEvent.xml → ...isDocWithShippingAndTransportingEvent.xml
diff --git a/...thTransformationEventWithExtension.hashes → ...thTransformationEventWithExtension.hashes b/...thTransformationEventWithExtension.hashes → ...thTransformationEventWithExtension.hashes
diff --git a/...ransformationEventWithExtension.prehashes → ...ransformationEventWithExtension.prehashes b/...ransformationEventWithExtension.prehashes → ...ransformationEventWithExtension.prehashes
diff --git a/...cWithTransformationEventWithExtension.xml → ...cWithTransformationEventWithExtension.xml b/...cWithTransformationEventWithExtension.xml → ...cWithTransformationEventWithExtension.xml
diff --git a/...rmationEventWithMultipleExtensions.hashes → ...rmationEventWithMultipleExtensions.hashes b/...rmationEventWithMultipleExtensions.hashes → ...rmationEventWithMultipleExtensions.hashes
diff --git a/...tionEventWithMultipleExtensions.prehashes → ...tionEventWithMultipleExtensions.prehashes b/...tionEventWithMultipleExtensions.prehashes → ...tionEventWithMultipleExtensions.prehashes
diff --git a/...sformationEventWithMultipleExtensions.xml → ...sformationEventWithMultipleExtensions.xml b/...sformationEventWithMultipleExtensions.xml → ...sformationEventWithMultipleExtensions.xml
diff --git a/...ples/epcisDocWithVariousEventTypes.hashes → ...ples/epcisDocWithVariousEventTypes.hashes b/...ples/epcisDocWithVariousEventTypes.hashes → ...ples/epcisDocWithVariousEventTypes.hashes
diff --git a/...amples/epcisDocWithVariousEventTypes.json → ...amples/epcisDocWithVariousEventTypes.json b/...amples/epcisDocWithVariousEventTypes.json → ...amples/epcisDocWithVariousEventTypes.json
diff --git a/...s/epcisDocWithVariousEventTypes.prehashes → ...s/epcisDocWithVariousEventTypes.prehashes b/...s/epcisDocWithVariousEventTypes.prehashes → ...s/epcisDocWithVariousEventTypes.prehashes
diff --git a/...xamples/epcisDocWithVariousEventTypes.xml → ...xamples/epcisDocWithVariousEventTypes.xml b/...xamples/epcisDocWithVariousEventTypes.xml → ...xamples/epcisDocWithVariousEventTypes.xml
diff --git a/...WithXMLstartTagAndErrorDeclaration.hashes → ...WithXMLstartTagAndErrorDeclaration.hashes b/...WithXMLstartTagAndErrorDeclaration.hashes → ...WithXMLstartTagAndErrorDeclaration.hashes
diff --git a/...ocWithXMLstartTagAndErrorDeclaration.json → ...ocWithXMLstartTagAndErrorDeclaration.json b/...ocWithXMLstartTagAndErrorDeclaration.json → ...ocWithXMLstartTagAndErrorDeclaration.json
diff --git a/...hXMLstartTagAndErrorDeclaration.prehashes → ...hXMLstartTagAndErrorDeclaration.prehashes b/...hXMLstartTagAndErrorDeclaration.prehashes → ...hXMLstartTagAndErrorDeclaration.prehashes
diff --git a/...DocWithXMLstartTagAndErrorDeclaration.xml → ...DocWithXMLstartTagAndErrorDeclaration.xml b/...DocWithXMLstartTagAndErrorDeclaration.xml → ...DocWithXMLstartTagAndErrorDeclaration.xml
diff --git a/...ed_equal/ReferenceEventHashAlgorithm.json → ...ed_equal/ReferenceEventHashAlgorithm.json b/...ed_equal/ReferenceEventHashAlgorithm.json → ...ed_equal/ReferenceEventHashAlgorithm.json
diff --git a/...rentRepresentationsOfAggregationEvent.xml → ...rentRepresentationsOfAggregationEvent.xml b/...rentRepresentationsOfAggregationEvent.xml → ...rentRepresentationsOfAggregationEvent.xml
diff --git a/...differentRepresentationsOfObjectEvent.xml → ...differentRepresentationsOfObjectEvent.xml b/...differentRepresentationsOfObjectEvent.xml → ...differentRepresentationsOfObjectEvent.xml
diff --git a/...rentRepresentationsOfTransactionEvent.xml → ...rentRepresentationsOfTransactionEvent.xml b/...rentRepresentationsOfTransactionEvent.xml → ...rentRepresentationsOfTransactionEvent.xml
diff --git a/...tRepresentationsOfTransformationEvent.xml → ...tRepresentationsOfTransformationEvent.xml b/...tRepresentationsOfTransformationEvent.xml → ...tRepresentationsOfTransformationEvent.xml
diff --git a/src/test_explicit_hash_values.py → tests/test_explicit_hash_values.py b/src/test_explicit_hash_values.py → tests/test_explicit_hash_values.py
@@ -1,8 +1,13 @@
-from .epcis_event_hash_generator import epcis_hash
+try:
+   from .context import epcis_event_hash_generator
+except ImportError:
+   from context import epcis_event_hash_generator
+
+from epcis_event_hash_generator.epcis_event_hash_generator import epcis_hash
 
 from os import walk, path
 
-TEST_FILE_PATH = "../testFiles/examples/"
+TEST_FILE_PATH = "examples/"
 
 def test_explicit_hash_values():
     num_tested = 0

diff --git a/src/test_required_properties.py → tests/test_required_properties.py b/src/test_required_properties.py → tests/test_required_properties.py
@@ -1,9 +1,16 @@
-from .epcis_event_hash_generator import epcis_hash
+try:
+   from .context import epcis_event_hash_generator
+except ImportError:
+   from context import epcis_event_hash_generator
+
+
+from epcis_event_hash_generator.epcis_event_hash_generator import epcis_hash
+
 
 from os import walk
 
-TEST_FILE_PATH = "../testFiles/examples/"
-TEST_FILE_PATH_SAME_EVENT = "../testFiles/expected_equal/"
+TEST_FILE_PATH = "examples/"
+TEST_FILE_PATH_SAME_EVENT = "expected_equal/"
 
 
 def test_distinct():

diff --git a/src/test_xml_to_py.py → tests/test_xml_to_py.py b/src/test_xml_to_py.py → tests/test_xml_to_py.py
@@ -1,4 +1,9 @@
-from . import xml_to_py
+try:
+   from .context import epcis_event_hash_generator
+except ImportError:
+   from context import epcis_event_hash_generator
+
+from epcis_event_hash_generator import xml_to_py
 
 import xml.etree.ElementTree as ElementTree
 
@@ -22,7 +27,7 @@ def test_docstring_example():
 
 
 def test_epcsi_reference_example():
-    actual_obj = xml_to_py.event_list_from_epcis_document_xml("../testFiles/examples/ReferenceEventHashAlgorithm.xml")
+    actual_obj = xml_to_py.event_list_from_epcis_document_xml("examples/ReferenceEventHashAlgorithm.xml")
 
     print(actual_obj)