安装本项目的Python包
运行以下命令，安装模块包：
pip install flask-sqlalchemy-compat
额外功能
透过设置可选依赖项，可以安装更多功能：
pip install flask-sqlalchemy-compat[option1,option2...]
| 选项 | |
|---|---|
test | 安装用于进行pytest测试的依赖项。这些依赖项只用于单元测试，不用于提供任何实际功能。 |
dev | 安装开发者依赖项。构建模块包的时候才有可能需要这些依赖项。 |
backends | 安装flask-sqlalchemy和flask-sqlalchemy-lite。若当前 Python 版本不支持，则会跳过安装对应的包。 |
example | 安装用来运行范例脚本的依赖项。 |
后端
默认情况下，安装此模块包、并不会同时安装flask-sqlalchemy或flask-sqlalchemy-lite。这是因为本项目假设了用户已经自行决定、并安装过二者之一。
安装时，若附加上backends可选项、则会根据当前Python的版本，按照以下列表安装对应的包。
| Python 版本 | flask-sqlalchemy-lite | flask-sqlalchemy | flask-sqlalchemy-compat-backend-py37 |
|---|---|---|---|
~=3.7 | |||
~=3.8 | |||
>=3.9 |
注意
为了在Python=3.7时确保兼容性，用户需要安装一个非官方版本的flask-sqlalchemy，参见
https://github.com/pallets-eco/flask-sqlalchemy/issues/1140#issuecomment-1577921154
该非官方版本可以透过以下方式安装：
python -m pip install flask-sqlalchemy-compat[backends]
安装GitHub版本
在开发阶段，GitHub上的版本有可能比在PyPI发布的版本新。如果用户需要安装GitHub版本，请确保已经安装了Git。
确保一些需要的软件都准备无虞后，运行下列命令安装开发者版本：
git clone https://github.com/cainmagi/flask-sqlalchemy-compat
cd flask-sqlalchemy-compat
python -m pip install -r requirements.txt -r requirements-dev.txt
python -m pip install .[dev]
提示
若有需要，可以在pip install命令的后面加上-e。这将令所安装的模块支持即时修改。亦即，对从GitHub上clone的项目做出的任何改动都将反馈到全局安装的flask_sqlalchemy_compat模块包上。
运行测试
要检查此项目是否兼容当前设备，请确保已经安装了Git。
确保一些需要的软件都准备无虞后，运行下列命令进行单元测试：
git clone https://github.com/cainmagi/flask-sqlalchemy-compat
cd flask-sqlalchemy-compat
python -m pip install -r requirements.txt -r requirements-backends.txt -r tests/requirements.txt
python -m pytest
本项目只兼容到python>=3.7版本。如果你发现你所使用的版本无法通过单元测试，请提交问题报告：