Skip to content

Commit

Permalink
small documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
Ypurek committed May 1, 2024
1 parent 815b974 commit efb7fbd
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 32 deletions.
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,7 @@
## Installation

```bash
pip install git+https://github.com/tikolakin/pytestomatio.git@1.7#egg=pytestomatio
```

## configuration

Create environment variable `TESTOMATIO` and set your testomat.io API key.
Linux:

```bash
export TESTOMATIO=<key>
```

Windows (cmd):

```bash
set TESTOMATIO=<key>
```

### Run groups parameter
There is environment variable `TESTOMATIO_RUNGROUP_TITLE` that can be used to specify run tests with specific group title.

### pytest.ini
In case you are using private testomat.io service, create `pytest.ini` file in your project root directory. Specify
testomat.io url in it

```ini
[pytest]
testomatio_url = https://app.testomat.io

pip install pytestomatio
```

## Usage
Expand Down Expand Up @@ -70,6 +42,34 @@ Run pytest with debug parameter to get test data collected in metadata.json file
pytest --testomatio debug
```

## configuration

Create environment variable `TESTOMATIO` and set your testomat.io API key.
Linux:

```bash
export TESTOMATIO=<key>
```

Windows (cmd):

```bash
set TESTOMATIO=<key>
```

### Run groups parameter
There is environment variable `TESTOMATIO_RUNGROUP_TITLE` that can be used to specify run tests with specific group title.

### pytest.ini
In case you are using private testomat.io service, create `pytest.ini` file in your project root directory. Specify
testomat.io url in it

```ini
[pytest]
testomatio_url = https://app.testomat.io

```

### Submitting Test Run Environment

to configure test environment, you can use additional option:
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ version_provider = "pep621"
update_changelog_on_bump = true
[project]
name = "pytestomatio"
version = "2.2.1"
version = "2.2.2"

dependencies = [
"requests>=2.29.0",
Expand All @@ -38,8 +38,8 @@ classifiers = [

[project.urls]
"Testomat.io" = "https://testomat.io/"
"Homepage" = "https://github.com/tikolakin/pytestomatio"
"Bug Tracker" = "https://github.com/tikolakin/pytestomatio/issues"
"Homepage" = "https://github.com/testomatio/pytestomatio"
"Bug Tracker" = "https://github.com/testomatio/pytestomatio/issues"

[project.entry-points.pytest11]
pytestomatio = "pytestomatio.main"

0 comments on commit efb7fbd

Please sign in to comment.