splunk / splunk-sdk-python

Splunk Software Development Kit for Python
http://dev.splunk.com
Apache License 2.0
687 stars 369 forks source link

examplename.py is not present in the repository #353

Closed amaljose01 closed 3 years ago

amaljose01 commented 3 years ago

examplename.py file is not present in the git repo based on the below documentation

Run the examples Examples are located in the /splunk-sdk-python/examples directory. To run the examples at the command line, use the Python interpreter and include any arguments that are required by the example:

python examplename.py --username="admin" --password="changeme" If you saved your login credentials in the .splunkrc file, you can omit those arguments:

python examplename.py To get help for an example, use the --help argument with an example:

python examplename.py --help

tdhellmann commented 3 years ago

Which specific example were you trying to run?

amaljose01 commented 3 years ago

I am not running anything specifically, the file examplename.py is not found in the repo provided as per the documentation

ahvigil commented 3 years ago

i think its implied that you replace examplename.py with the name of the example you'd like to run. Perhaps this can be made more explicit in the documentation.

tdhellmann commented 3 years ago

Right, there's not a specific example named "examplename.py", you have to replace "examplename" with the specific example in that directory that you want to run.

amaljose01 commented 3 years ago

Thanks @tdhellmann and @ahvigil , will do the same, it would be better if we could add an extra line in the documentation for the people trying out this for the first time

ncanumalla-splunk commented 3 years ago

Thanks for the feedback. Readme has been updated. Closing this issue.