Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change extra installations to specific drivers #436

Merged
merged 4 commits into from
Jan 18, 2022

Conversation

aminalaee
Copy link
Member

@aminalaee aminalaee commented Dec 10, 2021

Closes #429 and closes #421.

Changes extra installations from:

pip install databases[postgresql+asyncpg]

To:

pip install databases[asyncpg]

This will be a step towards downplaying the default drivers.
Even though it keeps default drivers to work like pip install databases[postgresql] but will remove them from the docs to point to specific drivers.

And also worth mentioning that this will be the API, still mentioned the default in the docs:

database = Database('sqlite:///example.db')

This is equivalent to:

database = Database('sqlite+aiosqlite:///example.db')

I think we should also downplay the default dialect and specify the driver in the docs.

@aminalaee aminalaee requested a review from a team December 10, 2021 10:22
@aminalaee aminalaee changed the title change extra_requires Change extra installations to specific drivers Dec 10, 2021
@aminalaee
Copy link
Member Author

@collerek Do you think you can review this?

docs/index.md Show resolved Hide resolved
setup.py Show resolved Hide resolved
@aminalaee
Copy link
Member Author

aminalaee commented Jan 16, 2022

@collerek thanks for the review. that makes sense.
I'll also update documentation for the database URI to downplay the idea of default drivers:

So instead of this:

database = Database('sqlite:///example.db')

We would use this in the docs:

database = Database('sqlite+aiosqlite:///example.db')

Even though both will work for now, but we wouldn't encourage the default drivers both in installation and usage.

@aminalaee aminalaee mentioned this pull request Jan 16, 2022
@aminalaee aminalaee merged commit c2417cd into master Jan 18, 2022
@aminalaee aminalaee deleted the fix-extra-requires-installations branch January 18, 2022 10:08
collerek added a commit that referenced this pull request Jan 20, 2022
skuda pushed a commit to skuda/databases that referenced this pull request Mar 31, 2022
skuda pushed a commit to skuda/databases that referenced this pull request Mar 31, 2022
@aminalaee aminalaee mentioned this pull request May 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants