{:toc}
- Fix: Correct typos in the docstrings.
- Fix: Remove unwanted printed information.
- Fix: Fix the typos in the docstrings.
- Fix: Correct the
usage.py
where the instance path and the engine options are not configured properly. - Fix:
utilities.clone_method
andutilities.clone_function
does not provide correct signature in run time. Correct the signature manually.
- Adjust the project information. This change is mainly targeted for adding the documentation link.
- Make
backends.fsa
andbackends.fsa_lite
protected bybackends.proxy
. The other parts of this project will access backends module by this newly addedproxy
. This change allows users to deliberately changeproxy
for testing purposes. For example, the users can disableflask-sqlalchemy
by settingproxy.fsa = None
even if the package is already installed. - Provide two new methods
get_flask_sqlalchemy_proxy_ver(...)
andget_flask_sqlalchemy_lite_proxy_ver(...)
. In run time, they are totally the same asget_flask_sqlalchemy(...)
andget_flask_sqlalchemy_lite(...)
, respectively. The only difference is that the returned values of_proxy_ver(...)
are notated by the the proxy classes likeSQLAlchemyProxy
. Users can use these methods to check the compatibility with the falling back version via the static type checker. - Add three examples (demos):
examples.app_fsqla
,examples.app_fsqla_lite
,usage
. - Add unit tests and the corresponding configurations.
- Add the GitHub workflow for running the unit tests.
- Fix: When the module is reloaded, accessing the
SQLAlchemyProxy().Model.query
may causeRuntimeError
. Now, this error has been catched. - Fix: Prevent
flake8
from raisingF722
when working with older python versions (Python<3.10
).
- Update the metadata of the package. The chages are made for adjusting the new optional dependencies and tests.
- Update the project information for preparing to upload a new PyPI release.
- Fix: Previously, running
db.init_app(...)
outside the app context will fail ifdb
is provided by the proxy class. Now, theinit_app
can be used without limitations.
- Adjust the readme file to make the examples consistent with the
db.init_app
behavior in the new version.
- Fix: Adjust the dependency versions to make the requirements satisfy the usage in
Python=3.13
.
- Fix: Stabilize the backend import when using
Python=3.7
, where the compatible backend will provide an version that would not be overridden by other installations. - Fix: Correct the package information. The package should be zip-safe and does not include extra data.
- Fix: Correct some out-of-date information in the readme file.
- Fix: Make some type hint excluded from the run time to improve the stability.
- Fix: Adjust the dependency versions to match the requirements specified in
flask-sqlalchemy-lite
.
- Add more files to the exclude list of
black
.
- Create this project.
- Finish the first version of the pacakge
flask-sqlalchemy-compat
. - Add configurations
pyproject.toml
. - Add the devloper's environment folder
./docker
and theDockerfile
. - Add the community guideline files:
CODE_OF_CONDUCT.md
,CONTRIBUTING.md
, andSECURITY.md
. - Add the issue and pull request templates.
- Configure the github workflows for publishing the package.
- Add the banner and adjust the format in the readme.
- Fix: Adjust the formats of the
requirements
to make them compatible withpyproject.toml
. - Fix: A Git-sourced dependency is not approved by PyPI. Therefore, replace the Git source by a customized related package:
Flask-SQLAlchemy-compat-backend-py37
.
- Adjust the metadata according to the current project status.