Skip to content
This repository was archived by the owner on Aug 19, 2025. It is now read-only.

Commit 4be891f

Browse files
authored
update installation docs (#374)
1 parent 0a06a5f commit 4be891f

3 files changed

Lines changed: 17 additions & 2 deletions

File tree

docs/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ $ pip install databases[mysql]
3737
$ pip install databases[sqlite]
3838
```
3939

40-
Driver support is providing using one of [asyncpg][asyncpg], [aiomysql][aiomysql], or [aiosqlite][aiosqlite].
40+
Driver support is provided using one of [asyncpg][asyncpg], [aiomysql][aiomysql], or [aiosqlite][aiosqlite].
41+
Note that if you are using any synchronous SQLAlchemy functions such as `engine.create_all()` or [alembic][alembic] migrations then you still have to install a synchronous DB driver: [psycopg2][psycopg2] for PostgreSQL and [pymysql][pymysql] for MySQL.
4142

4243
---
4344

@@ -91,6 +92,8 @@ for examples of how to start using databases together with SQLAlchemy core expre
9192
[sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/
9293
[sqlalchemy-core-tutorial]: https://docs.sqlalchemy.org/en/latest/core/tutorial.html
9394
[alembic]: https://alembic.sqlalchemy.org/en/latest/
95+
[psycopg2]: https://www.psycopg.org/
96+
[pymysql]: https://github.com/PyMySQL/PyMySQL
9497
[asyncpg]: https://github.com/MagicStack/asyncpg
9598
[aiomysql]: https://github.com/aio-libs/aiomysql
9699
[aiosqlite]: https://github.com/jreese/aiosqlite

scripts/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Development Scripts
22

3+
* `scripts/build` - Build package and documentation.
34
* `scripts/clean` - Delete any build artifacts.
5+
* `scripts/docs` - Run documentation server locally.
46
* `scripts/install` - Install dependencies in a virtual environment.
5-
* `scripts/test` - Run the test suite.
67
* `scripts/lint` - Run the code linting.
78
* `scripts/publish` - Publish the latest version to PyPI.
9+
* `scripts/test` - Run the test suite.
810

911
Styled after GitHub's ["Scripts to Rule Them All"](https://github.com/github/scripts-to-rule-them-all).

scripts/docs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/bin/sh -e
2+
3+
export PREFIX=""
4+
if [ -d 'venv' ] ; then
5+
export PREFIX="venv/bin/"
6+
fi
7+
8+
set -x
9+
10+
${PREFIX}mkdocs serve

0 commit comments

Comments
 (0)