Skip to content

Commit edf6d84

Browse files
committed
Add note about supported backends to the README
1 parent 3cf9fad commit edf6d84

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ transactions using [Flask-SQLAlchemy](http://flask-sqlalchemy.pocoo.org/latest/)
1313
- [Installation](#installation)
1414
- [From PyPi](#from-pypi)
1515
- [Development version](#development-version)
16+
- [Supported backends](#supported-backends)
1617
- [Configuration](#configuration)
1718
- [Conftest setup](#conftest-setup)
1819
- [Test configuration](#test-configuration)
@@ -147,6 +148,20 @@ You can install using pip:
147148
pip install .
148149
```
149150

151+
### <a name="supported-backends">Supported backends</a>
152+
153+
So far, pytest-flask-sqlalchemy has been most extensively tested against
154+
PostgreSQL 9.6. It should theoretically work with any backend that is supported
155+
by SQLAlchemy, but Postgres is the only backend that is currently tested by the
156+
test suite.
157+
158+
Official support for SQLite and MySQL is [planned for a future
159+
release](https://github.com/jeancochrane/pytest-flask-sqlalchemy/issues/3).
160+
In the meantime, if you're using one of those backends and you run in to
161+
problems, we would greatly appreciate your help! [Open an
162+
issue](https://github.com/jeancochrane/pytest-flask-sqlalchemy/issues/new) if
163+
something isn't working as you expect.
164+
150165
## <a name="configuration"></a>Configuration
151166

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

0 commit comments

Comments
 (0)