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

Update Documentation for FastAPISessionMaker and SQLAlchemy Session Management #354

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sahil-soni18
Copy link

This PR improves the documentation for the fastapi_utils.session module, specifically focusing on the usage of the FastAPISessionMaker class for managing SQLAlchemy sessions in FastAPI applications. The key updates include:

  • Clear and concise explanations of the steps required to configure and use the FastAPISessionMaker class.
  • Refined example code to better illustrate the process of defining ORM tables, configuring the database URI, and creating a get_db dependency for session management.
  • Updates to ensure best practices are emphasized, particularly regarding session finalization and error handling.
  • Removal of repetitive code in the documentation, ensuring that each step is explained with specific parts of the code, rather than the entire code block.

These updates aim to make the process of integrating SQLAlchemy with FastAPI more understandable and approachable for developers.

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.

1 participant