Test and document Flask-SQLAlchemy with delayed init_app

Open
#511 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
flask, python, sqlalchemy
Domain
backend, databases, documentation, testing

Research direction

Start with the Flask-SQLAlchemy API reference linked in the issue and trace the delayed SQLAlchemy() to init_app() sequence around instrument_sqlalchemy(). Add coverage and documentation for the supported ordering, with tests passing and the documented initialization guidance matching the behavior.

Written by the indexing model from the issue text.

Description

SQLAlchemy() allows construction without app set, waiting until a later init_app() call. We should test and document this case - it may mean instrument_sqlalchemy() shouldn't be called until after init_app().

https://flask-sqlalchemy.palletsprojects.com/en/2.x/api/#flask_sqlalchemy.SQLAlchemy

Dominant language
Python
Stars
77
Forks
19
Avg merge
1d 9h
Merged PRs (30d)
5

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from scoutapp/scout_apm_python

All issues in scoutapp/scout_apm_python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.