Move versioning to pyproject.toml, adjust version extracting to use importlib

Author: Ickerday

.github/workflows/release.yml

@@ -22,14 +22,14 @@ jobs:
         uses: pypa/[email protected]
         with:
           user: __token__
-          password: ${{ secrets.pypi_password }}
+          password: ${{ secrets.PYPI_PASSWORD }}
       - name: Install tox
         run: pip install tox
       - name: Generate API docs
         run: |
           rm -rf ./docs/_build
           tox -e docs
-      - name : Docs Upload
+      - name: Docs Upload
         uses: actions/upload-artifact@v3
         with:
           name: python_sdk_docs

.github/workflows/test.yml

@@ -1,17 +1,15 @@
 name: Python CI
 
-on:
-  [ push, workflow_dispatch ]
+on: [push, workflow_dispatch]
 
 jobs:
   build:
-
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os:
           - ubuntu-latest
-        python: [ 3.9, 3.13 ]
+        python: [3.9, 3.13]
         splunk-version:
           - "8.1"
           - "8.2"
@@ -34,7 +32,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Run docker compose
-        run: SPLUNK_VERSION=${{matrix.splunk-version}} docker compose up -d
+        run: SPLUNK_VERSION=${{ matrix.splunk-version }} docker compose up -d
 
       - name: Setup Python
         uses: actions/setup-python@v4
@@ -48,4 +46,4 @@ jobs:
         run: tox -e py
   fossa-scan:
     uses: splunk/oss-scanning-public/.github/workflows/oss-scan.yml@main
-    secrets: inherit
+    secrets: inherit

.gitignore

@@ -20,7 +20,6 @@ tests/searchcommands/data/app/app.log
 tests/searchcommands/apps/app_with_logging_configuration/*.log
 Test Results*.html
 splunk_sdk.egg-info/
-splunk_sdk_python.egg-info/
 dist/
 *.observed
 venv/

VERSION

@@ -14,21 +14,29 @@
 
 """Python library for Splunk."""
 
+# Assure backport for Python <3.9
+try:
+    from importlib.metadata import version as importlib_metadata_version
+except (ImportError, ModuleNotFoundError):
+    from importlib_metadata import version as importlib_metadata_version
+
 import logging
 
-DEFAULT_LOG_FORMAT = '%(asctime)s, Level=%(levelname)s, Pid=%(process)s, Logger=%(name)s, File=%(filename)s, ' \
-                     'Line=%(lineno)s, %(message)s'
-DEFAULT_DATE_FORMAT = '%Y-%m-%d %H:%M:%S %Z'
+DEFAULT_LOG_FORMAT = (
+    "%(asctime)s, Level=%(levelname)s, Pid=%(process)s, Logger=%(name)s, File=%(filename)s, "
+    "Line=%(lineno)s, %(message)s"
+)
+DEFAULT_DATE_FORMAT = "%Y-%m-%d %H:%M:%S %Z"
 
 
 # To set the logging level of splunklib
 # ex. To enable debug logs, call this method with parameter 'logging.DEBUG'
 # default logging level is set to 'WARNING'
-def setup_logging(level, log_format=DEFAULT_LOG_FORMAT, date_format=DEFAULT_DATE_FORMAT):
-    logging.basicConfig(level=level,
-                        format=log_format,
-                        datefmt=date_format)
+def setup_logging(
+    level, log_format=DEFAULT_LOG_FORMAT, date_format=DEFAULT_DATE_FORMAT
+):
+    logging.basicConfig(level=level, format=log_format, datefmt=date_format)
 
 
-__version_info__ = (2, 1, 0)
-__version__ = ".".join(map(str, __version_info__))
+# Extract current package version from pyproject.toml
+__version__: str = importlib_metadata_version("splunk-sdk")