Skip to content

Commit fa7fb74

Browse files
committed
Assorted small changes
1 parent 79d2dd5 commit fa7fb74

File tree

5 files changed

+17
-7
lines changed

5 files changed

+17
-7
lines changed

MANIFEST.in

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
include README.md
1+
include README.md
2+
include LICENSE
3+
include pyproject.toml

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,10 @@ Install the sources you cloned from GitHub:
5959

6060
You'll need `docker` and `docker-compose` to get up and running using this method.
6161

62+
Also see: [Updating the .env file](#updating-the-env-file)
63+
6264
```shell
65+
cp ./.env.template ./.env
6366
make up SPLUNK_VERSION=latest # also available: 10, 9.4
6467
make wait_up
6568
make test
@@ -95,7 +98,7 @@ To run the examples and unit tests, you must put the root of the SDK on your PYT
9598

9699
###
97100

98-
#### Update a .env file
101+
#### Updating the .env file
99102

100103
To connect to Splunk Enterprise, many of the SDK examples and unit tests take command-line arguments that specify values for the host, port, and login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a **.env** file. Then, the SDK examples and unit tests use the values from the **.env** file when you don't specify them.
101104

@@ -115,7 +118,7 @@ Here is an example of .env file:
115118
# Access scheme (default: https)
116119
scheme=https
117120
# Your version of Splunk Enterprise
118-
version=9.2
121+
version=10
119122
# Bearer token for authentication
120123
#splunkToken=<Bearer-token>
121124
# Session key for authentication

sitecustomize.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@
2020
import coverage
2121

2222
coverage.process_startup()
23-
except:
23+
except: # noqa: E722
2424
# TODO: Add logging
2525
pass

splunk-sdk-python.code-workspace

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,19 @@
1313
"envname",
1414
"eventingcsc",
1515
"healthcheck",
16+
"isort",
1617
"junitxml",
1718
"levelname",
1819
"LICEN",
1920
"modularinput",
2021
"mypy",
2122
"passenv",
2223
"posargs",
24+
"pycodestyle",
25+
"pyflakes",
2326
"pypa",
2427
"pypi",
28+
"pyproject",
2529
"pytest",
2630
"PYTHONPATH",
2731
"sdist",
@@ -31,7 +35,9 @@
3135
"Splunkd",
3236
"splunklib",
3337
"testlib",
34-
"TOXBUILD"
38+
"TOXBUILD",
39+
"venv",
40+
"virtualenv"
3541
]
3642
},
3743
"extensions": {

tests/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Splunk Test Suite
22

33
The test suite uses Python's standard library and the built-in **unittest**
4-
library. The Splunk Enterprise SDK for Python has been tested with Python v3.7
5-
and v3.9.
4+
library. The Splunk Enterprise SDK for Python has been tested with Python 3.9.23 and 3.13.5.
65

76
To run the unit tests, open a command prompt in the **/splunk-sdk-python**
87
directory and enter:

0 commit comments

Comments
 (0)