Skip to content

Commit 4da7ed5

Browse files
committed
Make documentation clearer
1 parent 1f56b9a commit 4da7ed5

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

MANIFEST.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
README.md
1+
README.md
2+
LICENSE

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Build Status](https://travis-ci.org/jeancochrane/pytest-flask-sqlalchemy-transactions.svg?branch=master)](https://travis-ci.org/jeancochrane/pytest-flask-sqlalchemy-transactions) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Django.svg)
44

55
A [pytest](https://docs.pytest.org/en/latest/) plugin providing fixtures for running tests in
6-
transactions using Flask and SQLAlchemy.
6+
transactions using [Flask-SQLAlchemy](http://flask-sqlalchemy.pocoo.org/latest/).
77

88
## Contents
99

@@ -15,7 +15,7 @@ transactions using Flask and SQLAlchemy.
1515
- [Development version](#development-version)
1616
- [Configuration](#configuration)
1717
- [Conftest setup](#conftest-setup)
18-
- [Test configuration (.ini or .cfg file)](#test-configuration-ini-or-cfg-file)
18+
- [Test configuration](#test-configuration)
1919
- [`mocked-engines`](#mocked-engines)
2020
- [`mocked-sessions`](#mocked-sessions)
2121
- [`mocked-sessionmakers`](#mocked-sessionmakers)
@@ -32,11 +32,11 @@ transactions using Flask and SQLAlchemy.
3232

3333
Inspired by [Django's built-in support for transactional
3434
tests](https://jeancochrane.com/blog/django-test-transactions), this plugin
35-
seeks to provide comprehensive, easy-to-use fixtures for wrapping tests in
36-
database transactions using Pytest, Flask, and SQLAlchemy. We aim to make
37-
testing stateful Flask applications easier by providing fixtures that permit
38-
the developer to **make arbitrary database updates with the confidence that
39-
any changes made during a test will roll back** once the test exits.
35+
seeks to provide comprehensive, easy-to-use Pytest fixtures for wrapping tests in
36+
database transactions for [Flask-SQLAlchemy](http://flask-sqlalchemy.pocoo.org/latest/)
37+
apps. The goal is to make testing stateful Flask-SQLAlchemy applications easier by
38+
providing fixtures that permit the developer to **make arbitrary database updates
39+
with the confidence that any changes made during a test will roll back** once the test exits.
4040

4141
## Quick examples
4242

@@ -70,7 +70,7 @@ def test_transaction_doesnt_persist(db_engine):
7070
assert row_name != 'testing'
7171
```
7272

73-
Use [configuration properties](#test-configuration-ini-or-cfg-file) to
73+
Use [configuration properties](#test-configuration) to
7474
**mock database connections in an app and enforce nested transactions**,
7575
allowing any method from the codebase to run inside a test with the assurance
7676
that any database changes made will be rolled back at the end of the test:
@@ -246,11 +246,11 @@ def _db(database):
246246
return database
247247
```
248248

249-
### Test configuration (.ini or .cfg file)
249+
### Test configuration
250250

251-
This plugin allows you to configure a few different properties in the test
252-
configuration file in order to handle the specific database connection needs
253-
of an app. For basic background on setting up pytest configuration files, see
251+
This plugin allows you to configure a few different properties in a
252+
`setup.cfg` test configuration file in order to handle the specific database connection needs
253+
of your app. For basic background on setting up pytest configuration files, see
254254
the [pytest docs](https://docs.pytest.org/en/latest/customize.html#adding-default-options).
255255

256256
All three configuration properties ([`mocked-engines`](#mocked-engines),

0 commit comments

Comments
 (0)