Merge pull request #456 from splunk/py3-code-migration

Removed Support for Python2

Author: ashah-splunk

.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Build package
         run: python setup.py sdist
       - name: Publish package to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.8
+        uses: pypa/gh-action-pypi-publish@v1.8.10
         with:
           user: __token__
           password: ${{ secrets.pypi_password }}

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
-        python: [3.7]
+        python: [ 3.7, 3.9]
         splunk-version:
           - "8.1"
           - "8.2"

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Splunk Enterprise SDK for Python Changelog
 
+## Version 2.0.0-beta
+
+### Feature updates
+* `ensure_binary`, `ensure_str` and `assert_regex` utility methods have been migrated from `six.py` to `splunklib/utils.py`
+
+### Major changes
+* Removed Code specific to Python2
+* Removed six.py dependency
+* Removed `__future__` imports
+* Refactored & Updated `splunklib` and `tests` to utilise Python3 features
+* Updated CI test matrix to run with Python versions - 3.7 and 3.9
+* Refactored Code throwing `deprecation` warnings
+* Refactored Code violating Pylint rules
 ## Version 1.7.4
 
 ### Bug fixes

Makefile

@@ -34,7 +34,7 @@ docs:
 .PHONY: test
 test:
 	@echo "$(ATTN_COLOR)==> test $(NO_COLOR)"
-	@tox -e py27,py37
+	@tox -e py37,py39
 
 .PHONY: test_specific
 test_specific:
@@ -44,17 +44,17 @@ test_specific:
 .PHONY: test_smoke
 test_smoke:
 	@echo "$(ATTN_COLOR)==> test_smoke $(NO_COLOR)"
-	@tox -e py27,py37 -- -m smoke
+	@tox -e py37,py39 -- -m smoke
 
 .PHONY: test_no_app
 test_no_app:
 	@echo "$(ATTN_COLOR)==> test_no_app $(NO_COLOR)"
-	@tox -e py27,py37 -- -m "not app"
+	@tox -e py37,py39 -- -m "not app"
 
 .PHONY: test_smoke_no_app
 test_smoke_no_app:
 	@echo "$(ATTN_COLOR)==> test_smoke_no_app $(NO_COLOR)"
-	@tox -e py27,py37 -- -m "smoke and not app"
+	@tox -e py37,py39 -- -m "smoke and not app"
 
 .PHONY: env
 env:

README.md

@@ -25,13 +25,13 @@ The Splunk Enterprise SDK for Python contains library code, and it's examples ar
 
 Here's what you need to get going with the Splunk Enterprise SDK for Python.
 
-* Python 2.7+ or Python 3.7. 
+* Python 3.7 or Python 3.9. 
 
-  The Splunk Enterprise SDK for Python has been tested with Python v2.7 and v3.7.
+  The Splunk Enterprise SDK for Python is compatible with python3 and has been tested with Python v3.7 and v3.9.
 
-* Splunk Enterprise 9.0 or 8.2
+* Splunk Enterprise 9.2 or 8.2
 
-    The Splunk Enterprise SDK for Python has been tested with Splunk Enterprise 9.0, 8.2 and 8.1
+    The Splunk Enterprise SDK for Python has been tested with Splunk Enterprise 9.2, 8.2 and 8.1
 
   If you haven't already installed Splunk Enterprise, download it [here](http://www.splunk.com/download). 
   For more information, see the Splunk Enterprise [_Installation Manual_](https://docs.splunk.com/Documentation/Splunk/latest/Installation).
@@ -61,7 +61,7 @@ Install the sources you cloned from GitHub:
 You'll need `docker` and `docker-compose` to get up and running using this method.
 
 ```
-make up SPLUNK_VERSION=9.0
+make up SPLUNK_VERSION=9.2
 make wait_up
 make test
 make down
@@ -110,7 +110,7 @@ here is an example of .env file:
     # Access scheme (default: https)
     scheme=https
     # Your version of Splunk Enterprise
-    version=9.0
+    version=9.2
     # Bearer token for authentication
     #splunkToken=<Bearer-token>
     # Session key for authentication

docs/conf.py

@@ -43,7 +43,7 @@
 
 # General information about the project.
 project = u'Splunk SDK for Python'
-copyright = u'2021, Splunk Inc'
+copyright = u'2024, Splunk Inc'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

scripts/build-env.py

@@ -1,4 +1,4 @@
-# Copyright 2011-2020 Splunk, Inc.
+# Copyright 2011-2024 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain

scripts/test_specific.sh

@@ -1,4 +1,4 @@
 echo "To run a specific test:"
-echo "  tox -e py27,py37 [test_file_path]::[TestClassName]::[test_method]"
+echo "  tox -e py37,py39 [test_file_path]::[TestClassName]::[test_method]"
 echo "For Example, To run 'test_autologin' testcase from 'test_service.py' file run"
 echo "  tox -e py37 -- tests/test_service.py::ServiceTestCase::test_autologin"

setup.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright 2011-2015 Splunk, Inc.
+# Copyright © 2011-2024 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain
@@ -24,10 +24,7 @@
 failed = False
 
 def run_test_suite():
-    try:
-        import unittest2 as unittest
-    except ImportError:
-        import unittest
+    import unittest
 
     def mark_failed():
         global failed

sitecustomize.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright 2011-2015 Splunk, Inc.
+# Copyright © 2011-2024 Splunk, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"): you may
 # not use this file except in compliance with the License. You may obtain