Skip to content

Commit 166f846

Browse files
artemrysArtem Rys
authored andcommitted
chore: update development instructions (#564)
1 parent b75147c commit 166f846

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.rst

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,18 @@ You can install "pytest-splunk-addon" via `pip`_ from `PyPI`_::
4040
Developing
4141
------------
4242

43-
Note: Must install docker desktop, vscode or pycharm pro optional
43+
Note: Must install docker desktop.
4444

4545
.. code:: bash
4646
4747
$ git clone --recurse-submodules -j8 [email protected]:splunk/pytest-splunk-addon.git
48-
49-
$ #setup python venv must be 3.7
50-
$ /Library/Frameworks/Python.framework/Versions/3.7/bin/python3 -m venv .venv
51-
52-
$ source .venv/bin/activate
53-
5448
$ cd pytest-splunk-addon
55-
56-
$ pip3 install -r requirements.txt
57-
58-
$ python setup.py develop
59-
49+
$ poetry install
50+
$ ... (change something)
51+
# run unit tests
52+
$ poetry run pytest tests/unit
53+
# run some of the docker-based tests to verify end-to-end behaviour, example:
54+
$ poetry run pytest -v --splunk-version=8.2 -m docker tests/test_splunk_addon.py::test_splunk_app_requirements_modinput
6055
6156
6257
Usage
@@ -86,9 +81,11 @@ Create a test file in the tests folder
8681
.. code:: python3
8782
8883
from pytest_splunk_addon.standard_lib.addon_basic import Basic
89-
class Test_App(Basic):
90-
def empty_method():
91-
pass
84+
85+
86+
class Test_App(Basic):
87+
def empty_method():
88+
pass
9289
9390
Create a Dockerfile-splunk file
9491

0 commit comments

Comments
 (0)