Switch extra installations to specific drivers (#436)

Co-authored-by: collerek <[email protected]>

Author: aminalaee

README.md

@@ -29,21 +29,22 @@ Databases is suitable for integrating against any async Web framework, such as [
 $ pip install databases
 ```
 
-You can install the required database drivers with:
-
-```shell
-$ pip install databases[postgresql]
-$ pip install databases[mysql]
-$ pip install databases[sqlite]
-```
+Database drivers supported are:
 
-Default driver support is provided using one of [asyncpg][asyncpg], [aiomysql][aiomysql], or [aiosqlite][aiosqlite].
+* [asyncpg][asyncpg]
+* [aiopg][aiopg]
+* [aiomysql][aiomysql]
+* [asyncmy][asyncmy]
+* [aiosqlite][aiosqlite]
 
-You can also use other database drivers supported by `databases`:
+You can install the required database drivers with:
 
-```shel
-$ pip install databases[postgresql+aiopg]
-$ pip install databases[mysql+asyncmy]
+```shell
+$ pip install databases[asyncpg]
+$ pip install databases[aiopg]
+$ pip install databases[aiomysql]
+$ pip install databases[asyncmy]
+$ pip install databases[aiosqlite]
 ```
 
 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.
@@ -56,7 +57,7 @@ For this example we'll create a very simple SQLite database to run some
 queries against.
 
 ```shell
-$ pip install databases[sqlite]
+$ pip install databases[aiosqlite]
 $ pip install ipython
 ```
 
@@ -68,7 +69,7 @@ expressions directly from the console.
 ```python
 # Create a database instance, and connect to it.
 from databases import Database
-database = Database('sqlite:///example.db')
+database = Database('sqlite+aiosqlite:///example.db')
 await database.connect()
 
 # Create a table.
@@ -103,8 +104,10 @@ for examples of how to start using databases together with SQLAlchemy core expre
 [psycopg2]: https://www.psycopg.org/
 [pymysql]: https://github.com/PyMySQL/PyMySQL
 [asyncpg]: https://github.com/MagicStack/asyncpg
+[aiopg]: https://github.com/aio-libs/aiopg
 [aiomysql]: https://github.com/aio-libs/aiomysql
-[aiosqlite]: https://github.com/jreese/aiosqlite
+[asyncmy]: https://github.com/long2ice/asyncmy
+[aiosqlite]: https://github.com/omnilib/aiosqlite
 
 [starlette]: https://github.com/encode/starlette
 [sanic]: https://github.com/huge-success/sanic

docs/connections_and_transactions.md

@@ -44,17 +44,17 @@ and for configuring the connection pool.
 
 ```python
 # Use an SSL connection.
-database = Database('postgresql://localhost/example?ssl=true')
+database = Database('postgresql+asyncpg://localhost/example?ssl=true')
 
 # Use a connection pool of between 5-20 connections.
-database = Database('mysql://localhost/example?min_size=5&max_size=20')
+database = Database('mysql+aiomysql://localhost/example?min_size=5&max_size=20')
 ```
 
 You can also use keyword arguments to pass in any connection options.
 Available keyword arguments may differ between database backends.
 
 ```python
-database = Database('postgresql://localhost/example', ssl=True, min_size=5, max_size=20)
+database = Database('postgresql+asyncpg://localhost/example', ssl=True, min_size=5, max_size=20)
 ```
 
 ## Transactions

docs/database_queries.md

@@ -34,7 +34,7 @@ You can now use any [SQLAlchemy core][sqlalchemy-core] queries ([official tutori
 ```python
 from databases import Database
 
-database = Database('postgresql://localhost/example')
+database = Database('postgresql+asyncpg://localhost/example')
 
 
 # Establish the connection pool

docs/index.md

@@ -27,21 +27,22 @@ Databases is suitable for integrating against any async Web framework, such as [
 $ pip install databases
 ```
 
-You can install the required database drivers with:
-
-```shell
-$ pip install databases[postgresql]
-$ pip install databases[mysql]
-$ pip install databases[sqlite]
-```
+Database drivers supported are:
 
-Default driver support is provided using one of [asyncpg][asyncpg], [aiomysql][aiomysql], or [aiosqlite][aiosqlite].
+* [asyncpg][asyncpg]
+* [aiopg][aiopg]
+* [aiomysql][aiomysql]
+* [asyncmy][asyncmy]
+* [aiosqlite][aiosqlite]
 
-You can also use other database drivers supported by `databases`:
+You can install the required database drivers with:
 
-```shel
-$ pip install databases[postgresql+aiopg]
-$ pip install databases[mysql+asyncmy]
+```shell
+$ pip install databases[asyncpg]
+$ pip install databases[aiopg]
+$ pip install databases[aiomysql]
+$ pip install databases[asyncmy]
+$ pip install databases[aiosqlite]
 ```
 
 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.
@@ -54,7 +55,7 @@ For this example we'll create a very simple SQLite database to run some
 queries against.
 
 ```shell
-$ pip install databases[sqlite]
+$ pip install databases[aiosqlite]
 $ pip install ipython
 ```
 
@@ -66,7 +67,7 @@ expressions directly from the console.
 ```python
 # Create a database instance, and connect to it.
 from databases import Database
-database = Database('sqlite:///example.db')
+database = Database('sqlite+aiosqlite:///example.db')
 await database.connect()
 
 # Create a table.
@@ -101,8 +102,10 @@ for examples of how to start using databases together with SQLAlchemy core expre
 [psycopg2]: https://www.psycopg.org/
 [pymysql]: https://github.com/PyMySQL/PyMySQL
 [asyncpg]: https://github.com/MagicStack/asyncpg
+[aiopg]: https://github.com/aio-libs/aiopg
 [aiomysql]: https://github.com/aio-libs/aiomysql
-[aiosqlite]: https://github.com/jreese/aiosqlite
+[asyncmy]: https://github.com/long2ice/asyncmy
+[aiosqlite]: https://github.com/omnilib/aiosqlite
 
 [starlette]: https://github.com/encode/starlette
 [sanic]: https://github.com/huge-success/sanic

setup.py

@@ -50,10 +50,13 @@ def get_packages(package):
     install_requires=["sqlalchemy>=1.4,<1.5", 'aiocontextvars;python_version<"3.7"'],
     extras_require={
         "postgresql": ["asyncpg"],
+        "asyncpg": ["asyncpg"],
+        "aiopg": ["aiopg"],
         "mysql": ["aiomysql"],
-        "mysql+asyncmy": ["asyncmy"],
+        "aiomysql": ["aiomysql"],
+        "asyncmy": ["asyncmy"],
         "sqlite": ["aiosqlite"],
-        "postgresql+aiopg": ["aiopg"],
+        "aiosqlite": ["aiosqlite"],
     },
     classifiers=[
         "Development Status :: 3 - Alpha",