Merge pull request #1 from kiesraad/module_cleanup

General structure cleanup for release

Author: chrismostert

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kiesraad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -3,12 +3,12 @@ Data bindings for the EML_NL Standard to load EML_NL files into Python [dataclas
 
 ## Requirements
 - At least Python version 3.10 for the [KW_ONLY](https://docs.python.org/3/library/dataclasses.html#dataclasses.KW_ONLY) type annotations for dataclasses. This is so that non-nullable fields can be marked as mandatory (see [here](https://xsdata.readthedocs.io/en/latest/faq/why-non-nullable-fields-are-marked-as-optional.html)).
-- [xsData](https://github.com/tefra/xsdata) for parsing using these databindings (`pip install xsdata`)
+- [xsData](https://github.com/tefra/xsdata) for parsing using these databindings.
 
 ## Testing
 The bindings are tested on over 2500 different EML files from different type of Dutch elections, all downloaded from [data.overheid.nl](https://data.overheid.nl/community/organization/kiesraad) using a roundtrip serialization test.
 
-See the [test report](test/pyeml_bindings_testreport.html)
+See the [test report](pyeml_bindings_testreport.html)
 
 ## Usage
 Make sure that xsData is installed. Using example file [`Telling_PS2023_Flevoland_gemeente_Almere.eml.xml`](https://data.overheid.nl/dataset/verkiezingsuitslag-provinciale-staten-2023#panel-resources) which has EML id 510b:
@@ -46,5 +46,11 @@ with open(Path("output.xml"), "w") as out_file:
 
 ```
 
+## Building
+To build the package yourself instead of installing the `.whl`, simply clone the repository and then in the root folder run. 
+```
+python -m build
+```
+
 ## Codegen
 These bindings are mostly generated using [xsData](https://xsdata.readthedocs.io) with some minor changes where needed. See commit history for these changes.

__init__.py renamed to pyeml_bindings/__init__.py

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyeml_bindings"
+description = "Data bindings for the EML_NL Standard"
+version = "1.0.0"
+authors = [{name = "Chris Mostert", email = "chris.mostert@kiesraad.nl"}]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "xsdata == 23.*"
+]
+license = {file = "LICENSE"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.optional-dependencies]
+tests = [
+  "pytest",
+  "formencode"
+]
+
+[project.urls]
+Home = "https://github.com/kiesraad/pyeml_bindings"

emlcore_kiesraad_strict.py renamed to pyeml_bindings/emlcore_kiesraad_strict.py

@@ -2,8 +2,8 @@
 from xsdata.formats.dataclass.parsers import XmlParser
 from xsdata.formats.dataclass.parsers.config import ParserConfig
 from xsdata.formats.dataclass.serializers import XmlSerializer
-from .. import Eml110a, Eml230, Eml510, Eml520
-from ..namespace import NAMESPACE
+from pyeml_bindings import Eml110a, Eml230, Eml510, Eml520
+from pyeml_bindings.namespace import NAMESPACE
 import xml.etree.ElementTree as ET
 from formencode.doctest_xml_compare import xml_compare
 from sys import stdout
@@ -28,7 +28,7 @@ def parsing_roundtrip_same(parser, serializer, reporter, path_to_eml, type) -> b
 parser = XmlParser(ParserConfig(fail_on_unknown_properties=False))
 serializer = XmlSerializer()
 reporter = lambda x: stdout.write(x + "\n")
-files = glob.glob(f"pyeml_bindings/test/data/**/*.eml.xml", recursive=True)
+files = glob.glob(f"data/**/*.eml.xml", recursive=True)
 
 test_cases = zip(
     itertools.repeat(parser),