From 1cc537f6f2864d75c5671b4a25987915fbd26ecd Mon Sep 17 00:00:00 2001
From: Claudio Satriano <satriano@gmail.com>
Date: Wed, 3 Jul 2024 12:25:23 +0200
Subject: [PATCH] Move all config-related files to a "config" directory

---
 setup.py                                             |  4 +++-
 sourcespec2/config/__init__.py                       | 12 ++++++++++++
 sourcespec2/{ => config}/config.py                   |  0
 sourcespec2/{ => config}/configobj/LICENSE           |  0
 sourcespec2/{ => config}/configobj/__init__.py       |  0
 sourcespec2/{ => config}/configobj/_version.py       |  0
 sourcespec2/{ => config}/configobj/validate.py       |  0
 sourcespec2/{config_files => config}/configspec.conf |  0
 sourcespec2/{config_files => config}/ssp_event.yaml  |  0
 sourcespec2/ssp_setup.py                             |  8 ++++----
 10 files changed, 19 insertions(+), 5 deletions(-)
 create mode 100644 sourcespec2/config/__init__.py
 rename sourcespec2/{ => config}/config.py (100%)
 rename sourcespec2/{ => config}/configobj/LICENSE (100%)
 rename sourcespec2/{ => config}/configobj/__init__.py (100%)
 rename sourcespec2/{ => config}/configobj/_version.py (100%)
 rename sourcespec2/{ => config}/configobj/validate.py (100%)
 rename sourcespec2/{config_files => config}/configspec.conf (100%)
 rename sourcespec2/{config_files => config}/ssp_event.yaml (100%)

diff --git a/setup.py b/setup.py
index a91508ea..b0a2a6c7 100644
--- a/setup.py
+++ b/setup.py
@@ -45,7 +45,9 @@
 
 setup(
     name='sourcespec2',
-    packages=['sourcespec2', 'sourcespec2.configobj', 'sourcespec2.adjustText'],
+    packages=[
+        'sourcespec2', 'sourcespec2.config.configobj', 'sourcespec2.adjustText'
+    ],
     include_package_data=True,
     entry_points={
         'console_scripts': [
diff --git a/sourcespec2/config/__init__.py b/sourcespec2/config/__init__.py
new file mode 100644
index 00000000..99d4a06a
--- /dev/null
+++ b/sourcespec2/config/__init__.py
@@ -0,0 +1,12 @@
+# -*- coding: utf8 -*-
+# SPDX-License-Identifier: CECILL-2.1
+"""
+Configuration classes and functions for SourceSpec
+
+:copyright:
+    2013-2024 Claudio Satriano <satriano@ipgp.fr>
+:license:
+    CeCILL Free Software License Agreement v2.1
+    (http://www.cecill.info/licences.en.html)
+"""
+from .config import Config  # noqa
diff --git a/sourcespec2/config.py b/sourcespec2/config/config.py
similarity index 100%
rename from sourcespec2/config.py
rename to sourcespec2/config/config.py
diff --git a/sourcespec2/configobj/LICENSE b/sourcespec2/config/configobj/LICENSE
similarity index 100%
rename from sourcespec2/configobj/LICENSE
rename to sourcespec2/config/configobj/LICENSE
diff --git a/sourcespec2/configobj/__init__.py b/sourcespec2/config/configobj/__init__.py
similarity index 100%
rename from sourcespec2/configobj/__init__.py
rename to sourcespec2/config/configobj/__init__.py
diff --git a/sourcespec2/configobj/_version.py b/sourcespec2/config/configobj/_version.py
similarity index 100%
rename from sourcespec2/configobj/_version.py
rename to sourcespec2/config/configobj/_version.py
diff --git a/sourcespec2/configobj/validate.py b/sourcespec2/config/configobj/validate.py
similarity index 100%
rename from sourcespec2/configobj/validate.py
rename to sourcespec2/config/configobj/validate.py
diff --git a/sourcespec2/config_files/configspec.conf b/sourcespec2/config/configspec.conf
similarity index 100%
rename from sourcespec2/config_files/configspec.conf
rename to sourcespec2/config/configspec.conf
diff --git a/sourcespec2/config_files/ssp_event.yaml b/sourcespec2/config/ssp_event.yaml
similarity index 100%
rename from sourcespec2/config_files/ssp_event.yaml
rename to sourcespec2/config/ssp_event.yaml
diff --git a/sourcespec2/ssp_setup.py b/sourcespec2/ssp_setup.py
index 8efdb281..677724ee 100644
--- a/sourcespec2/ssp_setup.py
+++ b/sourcespec2/ssp_setup.py
@@ -29,8 +29,8 @@
 from datetime import datetime
 from collections import defaultdict
 from . import __version__, __banner__
-from .configobj import ConfigObj
-from .configobj.validate import Validator
+from .config.configobj import ConfigObj
+from .config.configobj.validate import Validator
 from .config import Config
 from .ssp_update_db import update_db_file
 
@@ -266,7 +266,7 @@ def _read_config(config_file, configspec=None):
 
 def _parse_configspec():
     configspec_file = os.path.join(
-        os.path.dirname(__file__), 'config_files', 'configspec.conf')
+        os.path.dirname(__file__), 'config', 'configspec.conf')
     return _read_config(configspec_file)
 
 
@@ -578,7 +578,7 @@ def _init_traceid_map(traceid_map_file):
 def _write_sample_ssp_event_file():
     ssp_event_file = 'ssp_event.yaml'
     src_path = os.path.join(
-        os.path.dirname(__file__), 'config_files', 'ssp_event.yaml')
+        os.path.dirname(__file__), 'config', 'ssp_event.yaml')
     dest_path = os.path.join('.', ssp_event_file)
     write_file = True
     if os.path.exists(dest_path):