Summary

Update the README for pytest, standalone assertions, and users.

Review Request #11937 — Created Jan. 19, 2022 and submitted Jan. 20, 2022, 2:57 p.m.

Information

Owner

chipx86

Repository

kgb

Branch

master

Bugs

Depends On

Reviewers

Groups

kgb

People

Description

The README now shows all the common test environments that kgb supports.
Python unittest, pytest, and nose/nose2.

Examples have been updated to be more generic (less unittest-based) in
some cases, and to show how assertions work when using the mixin class,
the pytest fixture, or the standalone assertion methods.

The list of users have been fleshed out as well, showing some open
source projects I found that use kgb, and adding more of our own
products.

Installation instructions no longer recommend easy_install (even
though it still technically works).

Testing Done

Rendered the document. Tested the links. Checked the code samples for
obvious errors.

Commits

Summary	ID
Update the README for pytest, standalone assertions, and users. The README now shows all the common test environments that kgb supports. Python unittest, pytest, and nose/nose2. Examples have been updated to be more generic (less unittest-based) in some cases, and to show how assertions work when using the mixin class, the pytest fixture, or the standalone assertion methods. The list of users have been fleshed out as well, showing some open source projects I found that use kgb, and adding more of our own products. Installation instructions no longer recommend `easy_install` (even though it still technically works).	01e0b3b8d74a341ed288230c515a32c5c1a9138c

Summary

Update the README for pytest, standalone assertions, and users.

The README now shows all the common test environments that kgb supports. Python unittest, pytest, and nose/nose2. Examples have been updated to be more generic (less unittest-based) in some cases, and to show how assertions work when using the mixin class, the pytest fixture, or the standalone assertion methods. The list of users have been fleshed out as well, showing some open source projects I found that use kgb, and adding more of our own products. Installation instructions no longer recommend `easy_install` (even though it still technically works).

01e0b3b8d74a341ed288230c515a32c5c1a9138c

Issues

Description	From	Last Updated
We should use the snake versions of these functions for the pytest docs.	david	Jan. 20, 2022, 12:47 a.m.

flake8 passed.

JSHint passed.

Change Summary:

Updated the versions to be kgb 7 (we're dropping older Python versions in this release).

Commits:

	Summary	ID
	Update the README for pytest, standalone assertions, and users. The README now shows all the common test environments that kgb supports. Python unittest, pytest, and nose/nose2. Examples have been updated to be more generic (less unittest-based) in some cases, and to show how assertions work when using the mixin class, the pytest fixture, or the standalone assertion methods. The list of users have been fleshed out as well, showing some open source projects I found that use kgb, and adding more of our own products. Installation instructions no longer recommend `easy_install` (even though it still technically works).	c725854da715c1a299fd504449e5cba669c23473
	Update the README for pytest, standalone assertions, and users. The README now shows all the common test environments that kgb supports. Python unittest, pytest, and nose/nose2. Examples have been updated to be more generic (less unittest-based) in some cases, and to show how assertions work when using the mixin class, the pytest fixture, or the standalone assertion methods. The list of users have been fleshed out as well, showing some open source projects I found that use kgb, and adding more of our own products. Installation instructions no longer recommend `easy_install` (even though it still technically works).	0c91cfec79d0d71ed94197d7c497a8ffe39b1932

Diff:

Revision 2 (+370 -74)

Show changes

README.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

README.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
We should use the snake versions of these functions for the pytest docs.
```
1. chipx86 Jan. 20, 2022, 12:47 a.m.
  Oops, good point.

Change Summary:

Fixed the pytest and standalone assertion methods for snake_case.

Commits:

	Summary	ID
	Update the README for pytest, standalone assertions, and users. The README now shows all the common test environments that kgb supports. Python unittest, pytest, and nose/nose2. Examples have been updated to be more generic (less unittest-based) in some cases, and to show how assertions work when using the mixin class, the pytest fixture, or the standalone assertion methods. The list of users have been fleshed out as well, showing some open source projects I found that use kgb, and adding more of our own products. Installation instructions no longer recommend `easy_install` (even though it still technically works).	0c91cfec79d0d71ed94197d7c497a8ffe39b1932
	Update the README for pytest, standalone assertions, and users. The README now shows all the common test environments that kgb supports. Python unittest, pytest, and nose/nose2. Examples have been updated to be more generic (less unittest-based) in some cases, and to show how assertions work when using the mixin class, the pytest fixture, or the standalone assertion methods. The list of users have been fleshed out as well, showing some open source projects I found that use kgb, and adding more of our own products. Installation instructions no longer recommend `easy_install` (even though it still technically works).	01e0b3b8d74a341ed288230c515a32c5c1a9138c

Diff:

Revision 3 (+370 -74)

Show changes

README.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (ee97b43)

README.rst (Diff revision 2)