Skip to content

Commit

Permalink
Add note about supported backends to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
jeancochrane committed Aug 2, 2018
1 parent 3cf9fad commit edf6d84
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ transactions using [Flask-SQLAlchemy](http://flask-sqlalchemy.pocoo.org/latest/)
- [Installation](#installation)
- [From PyPi](#from-pypi)
- [Development version](#development-version)
- [Supported backends](#supported-backends)
- [Configuration](#configuration)
- [Conftest setup](#conftest-setup)
- [Test configuration](#test-configuration)
Expand Down Expand Up @@ -147,6 +148,20 @@ You can install using pip:
pip install .
```

### <a name="supported-backends">Supported backends</a>

So far, pytest-flask-sqlalchemy has been most extensively tested against
PostgreSQL 9.6. It should theoretically work with any backend that is supported
by SQLAlchemy, but Postgres is the only backend that is currently tested by the
test suite.

Official support for SQLite and MySQL is [planned for a future
release](https://github.com/jeancochrane/pytest-flask-sqlalchemy/issues/3).
In the meantime, if you're using one of those backends and you run in to
problems, we would greatly appreciate your help! [Open an
issue](https://github.com/jeancochrane/pytest-flask-sqlalchemy/issues/new) if
something isn't working as you expect.

## <a name="configuration"></a>Configuration

### <a name="conftest-setup"></a>Conftest setup
Expand Down

0 comments on commit edf6d84

Please sign in to comment.