moved source code to src/

Author: arbakker

MANIFEST.in

@@ -1,4 +1,4 @@
-recursive-include nl_service_metadata_generator/data/json *.json
-recursive-include nl_service_metadata_generator/data/templates *.xml
-recursive-include nl_service_metadata_generator/data/schema *.xsd
-recursive-include nl_service_metadata_generator/data/json_schema *.schema.json
+recursive-include src/nl_service_metadata_generator/data/json *.json
+recursive-include src/nl_service_metadata_generator/data/templates *.xml
+recursive-include src/nl_service_metadata_generator/data/schema *.xsd
+recursive-include src/nl_service_metadata_generator/data/json_schema *.schema.json

pyproject.toml

@@ -16,7 +16,7 @@ dependencies = [
     "lxml ~= 4.9",
     "jsonschema ~= 4.17"
 ]
-requires-python = ">=3.10.6"
+requires-python = ">=3.8.10"
 
 [project.optional-dependencies]
 dev = ["black", "autoflake", "isort"]
@@ -28,9 +28,13 @@ nl-service-metadata-generator = "nl_service_metadata_generator.cli:cli"
 include-package-data = true
 
 [tool.setuptools.packages.find]
+where = ["src"]
 include = ["nl_service_metadata_generator*"]  # package names should match these glob patterns (["*"] by default)
 exclude = []  # exclude packages matching these glob patterns (empty by default)
 
+[tool.setuptools.package-data]
+nl_service_metadata_generator = ["*.json", "*.xml", "*.xsd"]
+
 [build-system]
 build-backend = "setuptools.build_meta"
-requires = ["setuptools", "wheel"]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2", "wheel"]

nl_service_metadata_generator/__init__.py src/nl_service_metadata_generator/__init__.py

@@ -5,15 +5,15 @@
 
 import click
 
-from nl_service_metadata_generator.constants import DEFAULT_CSW_ENDPOINT
-from nl_service_metadata_generator.enums import (
+from .constants import DEFAULT_CSW_ENDPOINT
+from .enums import (
     InspireType,
     SchemaType,
     SdsType,
     ServiceType,
 )
-from nl_service_metadata_generator.metadata_generator import generate_service_metadata
-from nl_service_metadata_generator.util import print_schema, validate_service_metadata
+from .metadata_generator import generate_service_metadata
+from .util import print_schema, validate_service_metadata
 
 
 @click.group()

nl_service_metadata_generator/cli.py src/nl_service_metadata_generator/cli.py

@@ -2,7 +2,7 @@
 
 import pkg_resources
 
-from nl_service_metadata_generator.constants import CODELIST_JSON_FILE
+from .constants import CODELIST_JSON_FILE
 
 
 def get_inspire_theme_label(data_json):
@@ -58,7 +58,7 @@ def get_coordinate_reference_systems():
     with open(json_path, "r") as json_file:
         codelists_json = json.loads(json_file.read())
         return codelists_json["reference_systems"]
-        
+
 
 def get_sds_categories(sds_category):
     json_path = pkg_resources.resource_filename(__name__, CODELIST_JSON_FILE)

nl_service_metadata_generator/codelist_lookup.py src/nl_service_metadata_generator/codelist_lookup.py

@@ -3,8 +3,6 @@
 SERVICE_METADATA_SCHEMA = (
     "data/schema/schemas.opengis.net/csw/2.0.2/profiles/apiso/1.0.0/apiso.xsd"
 )
-JSON_SCHEMA_SERVICE = "data/json_schema/service.schema.json"
-JSON_SCHEMA_CONSTANTS = "data/json_schema/constants.schema.json"
 TEMPLATES_DIR = "data/templates"
 DEFAULT_CSW_ENDPOINT = "https://nationaalgeoregister.nl/geonetwork/srv/dut/csw"
 QUALITY_SERVICE_CONFORMANCE = {

nl_service_metadata_generator/constants.py src/nl_service_metadata_generator/constants.py

@@ -1,22 +1,20 @@
 import json
 from datetime import datetime
 
-from nl_service_metadata_generator.codelist_lookup import (
+from .codelist_lookup import (
     get_coordinate_reference_systems,
     get_inspire_fields_by_ogc_service_type,
     get_inspire_theme_label,
     get_sds_categories,
     get_service_protocol_values,
     get_spatial_dataservice_categories,
 )
-from nl_service_metadata_generator.constants import (
-    JSON_SCHEMA_CONSTANTS,
-    JSON_SCHEMA_SERVICE,
+from .constants import (
     QUALITY_SERVICE_CONFORMANCE,
     SERVICE_TEMPLATE,
 )
-from nl_service_metadata_generator.enums import InspireType, SdsType
-from nl_service_metadata_generator.util import (
+from .enums import InspireType, SchemaType, SdsType
+from .util import (
     camel_to_snake,
     format_xml,
     get_service_md_identifier,
@@ -43,9 +41,9 @@ def add_dynamic_fields(data_json, ogc_service_type, is_sds_interoperable):
     data_json["service_type"] = ogc_service_type
     protocol_fields = get_service_protocol_values(ogc_service_type)
     data_json.update(protocol_fields)
-    
+
     data_json["keywords"] = [x.lower() for x in data_json["keywords"]]
-    
+
     if is_sds_interoperable:
         if not "coordinate_reference_system" in data_json:
             raise ValueError("coordinateReferenceSystem field required in metadata config file when generating SDS Interoperable service metadata record")
@@ -54,7 +52,7 @@ def add_dynamic_fields(data_json, ogc_service_type, is_sds_interoperable):
 
         data_json["ref_system_name"] = ref_system["name"]
         data_json["ref_system_uri"] = ref_system["uri"]
-        
+
 
     if "protocol_version" in data_json:
         data_json["service_protocol_full_name"] = f'{data_json["service_protocol_name"]} - {data_json["protocol_version"]}'
@@ -107,8 +105,8 @@ def generate_service_metadata(
         constants_config = json.loads(constants_config_file.read())
 
         base_config = QUALITY_SERVICE_CONFORMANCE
-        validate_input_json(constants_config, JSON_SCHEMA_CONSTANTS)
-        validate_input_json(md_config, JSON_SCHEMA_SERVICE)
+        validate_input_json(constants_config, SchemaType.CONSTANTS)
+        validate_input_json(md_config, SchemaType.SERVICE)
         base_config.update(constants_config)
 
         base_config_snake = replace_keys(base_config, camel_to_snake)

src/nl_service_metadata_generator/data/__init__.py

@@ -1,18 +1,17 @@
 import json
+from pathlib import Path
 import re
 
 import pkg_resources
 from jinja2 import Environment, PackageLoader, select_autoescape
 from jsonschema import validate
 from lxml import etree
 
-from nl_service_metadata_generator.constants import (
-    JSON_SCHEMA_CONSTANTS,
-    JSON_SCHEMA_SERVICE,
+from .constants import (
     SERVICE_METADATA_SCHEMA,
     TEMPLATES_DIR,
 )
-from nl_service_metadata_generator.enums import SchemaType
+from .enums import SchemaType
 
 
 def render_template(template_path, data_json):
@@ -52,22 +51,23 @@ def replace_keys(dictionary: dict, fun) -> dict:
 
 
 def print_schema(schema_type: SchemaType):
-    if schema_type == SchemaType.CONSTANTS:
-        json_schema_path = JSON_SCHEMA_CONSTANTS
-    elif schema_type == SchemaType.SERVICE:
-        json_schema_path = JSON_SCHEMA_SERVICE
+    json_schema_path = f"data/json_schema/{schema_type}.schema.json"
     json_schema_path = pkg_resources.resource_filename(
-        __name__,
+        get_pkg_string(),
         json_schema_path,
     )
     with open(json_schema_path, "r") as f:
         parsed = json.load(f)
         print(json.dumps(parsed, indent=4))
 
+def get_pkg_string():
+    module_name = "." + __name__.replace(Path(__file__).name.replace(".py", ""),"")
+    return  __name__.replace(module_name, "")
 
-def validate_input_json(contact_config, json_schema_path):
+def validate_input_json(contact_config, schema_type: SchemaType):
+    json_schema_path = f"data/json_schema/{schema_type}.schema.json"
     contact_schema_path = pkg_resources.resource_filename(
-        __name__,
+        get_pkg_string(),
         json_schema_path,
     )
     with open(contact_schema_path, "r") as contact_json_schema:
@@ -112,7 +112,7 @@ def validate_service_metadata(xml_string):
     if result:
         return result
     schema_path = pkg_resources.resource_filename(
-        __name__,
+        get_pkg_string(),
         SERVICE_METADATA_SCHEMA,
     )
     with open(schema_path, "rb") as xml_schema_file: