add pyproject remove setup.py

Author: Cecylia Borek

.github/workflows/release.yml

@@ -13,11 +13,11 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
-      - name: Install dependencies
-        run: pip install twine
+          python-version: 3.9
+      - name: Install build and twine
+        run: pip install build twine
       - name: Build package
-        run: python setup.py sdist
+        run: python -m build
       - name: Publish package to PyPI
         uses: pypa/[email protected]
         with:

.gitignore

@@ -5,7 +5,6 @@
 *coverage_html_report*
 .coverage
 .coverage.*
-.python-version
 .vscode
 __stdout__
 docs/_build
@@ -24,5 +23,6 @@ dist/
 tests/searchcommands/apps/app_with_logging_configuration/*.log
 *.observed
 venv/
+.venv/
 .tox
 test-reports/

.python-version

@@ -0,0 +1 @@
+3.9

README.md

@@ -48,13 +48,9 @@ Use `pip`:
 
     [sudo] pip install splunk-sdk
 
-Install the Python egg:
-
-    [sudo] pip install --egg splunk-sdk
-
 Install the sources you cloned from GitHub:
 
-    [sudo] python setup.py install
+    [sudo] python -m pip install .
 
 ## Testing Quickstart
 

pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=68.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "splunk-sdk"
+version = "2.1.0"
+authors = [{ name = "Splunk, Inc.", email = "[email protected]" }]
+license.file = "LICENSE"
+description = "The Splunk Software Development Kit for Python"
+readme = "README.md"
+dependencies = ["deprecation>=2.1.0"]
+classifiers = [
+    "Programming Language :: Python",
+    "Development Status :: 6 - Mature",
+    "Environment :: Other Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+]
+
+[project.urls]
+Homepage = "http://github.com/splunk/splunk-sdk-python"
+
+
+[project.optional-dependencies]
+dev = ["tox>=4.8.0"]
+
+[tool.setuptools]
+packages = ["splunklib", "splunklib.modularinput", "splunklib.searchcommands"]

setup.py

@@ -16,19 +16,26 @@
 
 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'
+try:
+    import importlib.metadata as importlib
+except (ImportError, ModuleNotFoundError):
+    # For Python < 3.8, use importlib_metadata backport
+    import importlib_metadata as importlib
+
+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__))
+__version__ = importlib.version("splunk-sdk")