Skip to content

Installation

Python Version

Cherry-ORM only support Python 3.9+，Make sure your version of Python meets the requirements。

Installation

from PYPI

You can install Cherry-ORM using your favorite Python package manager, such as pip,poetry,pdm etc。

PIP

1
pip install cherry-orm

Poetry

1
poetry add cherry-orm

PDM

1
pdm add cherry-orm

from GIT

You can also install it from the source code to get the latest development version.

1
2
3
git clone https://github.com/CMHopeSunshine/cherry-orm
cd cherry-orm
pip install .

Optional Dependency

Choose which dependencies to install based on your database backend.

SQLite

1
2
3
4
5
pip install cherry-orm[sqlite]
# or
poetry add cherry-orm[sqlite]
# or
pdm add cherry-orm[sqlite]
aiosqlite will be installed for you to support asynchrony.

MySQL

1
2
3
4
5
pip install cherry-orm[mysql]
# or
poetry add cherry-orm[mysql]
# or
pdm add cherry-orm[mysql]
asyncmy will be installed for you to support asynchrony.

PostgreSQL

1
2
3
4
5
pip install cherry-orm[postgresql]
# or
poetry add cherry-orm[postgresql]
# or
pdm add cherry-orm[postgresql]
asyncpg will be installed for you to support asynchrony.

Install manually

Of course, you can manually install the back-end dependencies you need, such as pip install aiomysql。