Skip to content

Commit fa5962b

Browse files
committed
Edits to README and extensions docs
1 parent e0e4d9b commit fa5962b

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pyresttest
1212
# License
1313
Apache License, Version 2.0
1414

15-
![Status Badge](http://52.4.228.82:8080/jenkins/buildStatus/icon?job=set-main-build-status)
15+
![Status Badge](http://52.4.228.82:8080/jenkins/buildStatus/icon?job=set-main-build-status) [![PyPI version](https://badge.fury.io/py/pyresttest.svg)](https://badge.fury.io/py/pyresttest) and [Changelog](CHANGELOG.md)
1616

1717
# Sample Test
1818
**This will check that APIs accept operations, and will smoketest an application**
@@ -606,4 +606,4 @@ For pull requests to get easily merged, please:
606606
- Include documentation as appropriate
607607
- Attempt to adhere to PEP8 style guidelines and project style
608608

609-
Bear in mind that this is largely a one-man, outside-of-working-hours effort at the moment, so response times will vary.
609+
Bear in mind that this is largely a one-man, outside-of-working-hours effort at the moment, so response times will vary. That said: every feature request gets heard, and even if it takes a while, all the reasonable features will get incorporated. **If you fork the main repo, check back periodically... you may discover that the next release includes something to meet your needs and then some.**

extensions.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
PyRestTest provides hooks for extending built-in components with your own Python code.
33

44
# What Can An Extension Do?
5+
6+
- In general: use more advanced dependencies while not making them required for installation
57
- Generators: generate data for templating URL/request body/tests/etc
6-
- Extractors: get data from HTTP response body/headers
7-
- Validators: write custom tests of headers & request bodies
8+
- Extractors: get data from HTTP response body/headers and use it in future tests
9+
- Validators: write custom tests using headers & response bodies
810
- Test Functions: for the ExtractTest validator, validate a single condition
911
- Comparator function:s for the ComparatorValidator, compare expected and actual values
1012

@@ -49,8 +51,8 @@ It shows an extension for all extensible functions.
4951

5052
# What Doe An Extension Need To Work?
5153

52-
1. Function to run
53-
2. Registry Entries
54+
1. Function(s) to run
55+
2. Registry Entries: these are special ALLCAPS variables binding extension names
5456

5557
## Functions (different for each type)
5658

@@ -128,7 +130,7 @@ class HeaderExtractor(AbstractExtractor):
128130

129131
### Validators
130132
Validators should extend AbstractValidator.
131-
The parse function below will be registered in the registry.
133+
The parse function below will be registered in the registry VALIDATORS.
132134

133135
```python
134136
class ExtractTestValidator(AbstractValidator):
@@ -187,7 +189,7 @@ Each one maps to the same registry in pyresttest.validators.
187189

188190
# Use Case Suggestions
189191
- **Need to generate complex, formatted data?**
190-
- Write a generator extension, multiple generators may be used together to yield pieces of a result.
192+
- Write a generator extension, or multiple generators may be used together to create a complex result
191193
- **Want to test whether API results fit a business rule?**
192194
- Write a validator extension, your logic can be as complex as you like
193195
- **Want to apply a business rule to the output and use the result?**

0 commit comments

Comments
 (0)