Skip to content

Add pyproject async template to Alembic #1683

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

Closed
wants to merge 1 commit into from

Conversation

Alc-Alc
Copy link

@Alc-Alc Alc-Alc commented Jun 14, 2025

Description

This PR adds a new template "pyproject_async"* that can be used to bootstrap environments that want to use async DB-API with a pyproject.toml file. It also includes a minor update to the cookbook to add the name of the new template.

PR is similar to 8196af9 that added an async template.

Checklist

I am not sure if this warrants an issue, but I can create one if needed, my apologies if this is unclear.

This pull request is:

  • A documentation / typographical error fix
    • Good to go, no issue or tests are needed
  • A short code fix
    • please include the issue number, and create an issue if none exists, which
      must include a complete example of the issue. one line code fixes without an
      issue and demonstration will not be accepted.
    • Please include: Fixes: #<issue number> in the commit message
    • please include tests. one line code fixes without tests will not be accepted.
  • A new feature implementation
    • please include the issue number, and create an issue if none exists, which must
      include a complete example of how the feature would look.
    • Please include: Fixes: #<issue number> in the commit message
    • please include tests.

* - I have no strong commitments to the name of the template and can be bikeshed if needed. 😄

PS: This was a small change, so no worries at all if the maintainers choose not to proceed with it. 😇

Have a nice day!

@Alc-Alc
Copy link
Author

Alc-Alc commented Jun 20, 2025

@CaselIT / @zzzeek Apologies for the ping. Can you review this (whenever possible) 🙂

@zzzeek
Copy link
Member

zzzeek commented Jun 20, 2025

hi -

this is just the async + pyproject templates put together right? should be fine

@zzzeek zzzeek requested a review from sqla-tester June 20, 2025 12:56
Copy link
Collaborator

@sqla-tester sqla-tester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, this is sqla-tester setting up my work on behalf of zzzeek to try to get revision 46d03fb of this pull request into gerrit so we can run tests and reviews and stuff

@sqla-tester
Copy link
Collaborator

New Gerrit review created for change 46d03fb: https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/5994

@Alc-Alc
Copy link
Author

Alc-Alc commented Jun 20, 2025

this is just the async + pyproject templates put together right? should be fine

Appreciate the quick response. Yes, it is just async + pyproject.

@Alc-Alc
Copy link
Author

Alc-Alc commented Jun 24, 2025

Hey @zzzeek / @CaselIT, can you let me know if there is something wrong with this PR so I can fix it or is it an unrelated failure?

@sqla-tester
Copy link
Collaborator

Federico Caselli (CaselIT) wrote:

recheck pep8

View this in Gerrit at https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/5994

@zzzeek
Copy link
Member

zzzeek commented Jun 24, 2025

the pep8 stuff clearly has to do with the newer releases of flake8-import-order, I'll fix all that

@CaselIT
Copy link
Member

CaselIT commented Jun 24, 2025

the pep8 stuff clearly has to do with the newer releases of flake8-import-order, I'll fix all that

I think it may need changes to zimports to fix. We could pin that plugin for now

@CaselIT CaselIT closed this Jun 24, 2025
@CaselIT CaselIT reopened this Jun 24, 2025
@CaselIT
Copy link
Member

CaselIT commented Jun 24, 2025

Sorry, wrong button

@zzzeek
Copy link
Member

zzzeek commented Jun 24, 2025

yes, got the new zimports in, the fix w/ the type-checking is a lifesaver

@sqla-tester
Copy link
Collaborator

Gerrit review https://gerrit.sqlalchemy.org/c/sqlalchemy/alembic/+/5994 has been merged. Congratulations! :)

@Alc-Alc Alc-Alc deleted the async-pyproject branch June 25, 2025 02:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants