Modernize project to use pyproject.toml, review .gitignore and untrack any ignored files, update README (#660)

* Add pyproject.toml

* Add a properly fleshed-out .gitignore file

* Add .vscode to .gitignore

* Remove pytest from deps

* Remove tox.ini

* Simplify .gitignore a bit

* Remove XLSX file

* Remove test report generation, clean up tox config, remove setuptools from dependencies

* Update release workflow to use pyproject.toml

* Format Markdown files

* Add CD workflow for Test PyPI

* Remove .gitattributes as we don't store any binary files that use Git LFS

* Clean up Makefile

* Remove .pylintrc

* Remove scripts/

* Remove tests/README.md

* Update README

Author: Ickerday

.gitattributes

@@ -1,20 +1,20 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
+2. Click on '...'
+3. Scroll down to '...'
 4. See error
 
 **Expected behavior**
@@ -24,14 +24,16 @@ A clear and concise description of what you expected to happen.
 If applicable, add logs or screenshots to help explain your problem.
 
 **Splunk (please complete the following information):**
+
 - Version: [e.g. 8.0.5]
 - OS: [e.g. Ubuntu 20.04.1]
 - Deployment: [e.g. single-instance]
 
 **SDK (please complete the following information):**
- - Version: [e.g. 1.6.14]
- - Language Runtime Version: [e.g. Python 3.7]
- - OS: [e.g. MacOS 10.15.7]
+
+- Version: [e.g. 1.6.14]
+- Language Runtime Version: [e.g. Python 3.7]
+- OS: [e.g. MacOS 10.15.7]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,10 +1,7 @@
 ---
 name: Custom issue template
 about: Describe this issue template's purpose here.
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
-
-

.github/ISSUE_TEMPLATE/custom.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,15 +1,14 @@
 ---
 name: Pull Request Template
 about: Create a Pull Request to contribute to the SDK
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 ## Description of PR
 
-Provide the **context and motivation** for this PR. 
+Provide the **context and motivation** for this PR.
 Briefly explain the **type of changes** (bug fix, feature request, doc update, etc.) made in this PR. Provide reference to issue # fixed, if applicable.
 
 Describe the approach to the solution, the changes made, and any resulting change in behavior or impact to the user.

.github/PULL_REQUEST_TEMPLATE/pr_template.md

@@ -0,0 +1,28 @@
+name: CD
+on: [workflow_dispatch]
+
+jobs:
+  test-pypi-deploy:
+    name: Deploy to Test PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: splunk-test-pypi
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
+      - name: Set up Python
+        uses: actions/setup-python@3d1e2d2ca0a067f27da6fec484fce7f5256def85
+        with:
+          python-version: 3.9
+      - name: Install dependencies
+        run: pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package to Test PyPI
+        uses: pypa/gh-action-pypi-publish@d417ba7e7683fa9104c42abe611c1f2c93c0727d
+        with:
+          user: __token__
+          password: ${{ secrets.TEST_PYPI_PASSWORD }}
+          repository-url: https://test.pypi.org/legacy/

.github/workflows/cd.yml

@@ -1,5 +1,6 @@
 name: Fossa OSS Scan
 on: [push]
+
 jobs:
   fossa-scan:
     uses: splunk/oss-scanning-public/.github/workflows/oss-scan.yml@main

.github/workflows/fossa.yml

@@ -5,25 +5,28 @@ on:
 
 jobs:
   publish:
-    name: Deploy Release to PyPI
-    # Last version with Python 3.7 binaries available
-    runs-on: ubuntu-22.04
+    name: Deploy release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      name: splunk-pypi
     steps:
       - name: Checkout source
         uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
       - name: Set up Python
         uses: actions/setup-python@3d1e2d2ca0a067f27da6fec484fce7f5256def85
         with:
-          python-version: 3.7
+          python-version: 3.9
       - name: Install dependencies
-        run: pip install twine
+        run: pip install build
       - name: Build package
-        run: python setup.py sdist bdist_wheel
+        run: python -m build
       - name: Publish package to PyPI
         uses: pypa/gh-action-pypi-publish@d417ba7e7683fa9104c42abe611c1f2c93c0727d
         with:
           user: __token__
-          password: ${{ secrets.pypi_password }}
+          password: ${{ secrets.PYPI_PASSWORD }}
       - name: Install tox
         run: pip install tox
       - name: Generate API docs
@@ -35,10 +38,3 @@ jobs:
         with:
           name: python_sdk_docs
           path: docs/_build/html
-      # Test upload
-      # - name: Publish package to TestPyPI
-      #   uses: pypa/gh-action-pypi-publish@d417ba7e7683fa9104c42abe611c1f2c93c0727d
-      #   with:
-      #     user: __token__
-      #     password: ${{ secrets.test_pypi_password }}
-      #     repository_url: https://test.pypi.org/legacy/

.github/workflows/release.yml

@@ -32,4 +32,4 @@ jobs:
       - name: Install tox
         run: pip install tox
       - name: Test Execution
-        run: tox -e py
+        run: tox -e py -- ./tests