§1.1 环境搭建¶

一、环境要求¶

maliang 运行要求 Python 版本大于等于 3.10，操作系统没有过多要求（Windows、macOS、Linux 均可）。(1)

1. 💡但实际上我更推荐使用 Windows 操作系统

推荐使用 Python 3.11 及以上版本。

二、安装 maliang¶

2.1 纯净安装¶

maliang 目前的依赖包只有 Python 官方的 python/typing_extensions，安装时会自动安装依赖：

pip install maliang

2.2 完整安装¶

若想获取 maliang 的完整功能，用如下命令进行安装：

1
2

pip install maliang[opt]
pip install maliang[ext]

上述命令的第一条是安装 maliang 及其全部的可选依赖包，第二条命令是安装 maliang 的官方扩展包。

所有的可选依赖包信息如下：

• albertosottile/darkdetect: 提供操作系统主题检测
• python-pillow/Pillow: 提供更多类型图片的使用及优化图片缩放速度
• Akascape/py-window-styles: 提供一些 Windows 系统的窗口效果
• Zingzy/hPyT: 提供更多 Windows 系统窗口的配置选项
• littlewhitecloud/win32material: 提供更多 Windows 系统窗口的配置选项

所有的官方扩展包信息如下：

• Xiaokang2022/maliang-mpl: 提供 matplotlib 包的相关支持
• Xiaokang2022/maliang-media: 提供媒体文件的相关支持
• Xiaokang2022/maliang-three: 提供简单 3D 绘图的相关支持

如果您只想安装上述的部分包，可以单独使用 pip 进行安装。

2.3 推荐安装¶

以下是安装命令：

pip install maliang[opt]

maliang 目前所必须安装的依赖包只有上面提到的一个，它只是用来强化类型提示的，但为了您的良好体验，建议安装推荐的可选依赖包，即用 pip 安装时加上上述命令的 “opt” 字段。

2.4 升级安装¶

如果您之前安装过 maliang，但并不是最新版本，您可以通过以下命令进行升级：

pip install --upgrade maliang

当然，如果需要同步升级可选包或者扩展包，你可能需要下面的命令：

1
2

pip install --upgrade maliang[opt]
pip install --upgrade maliang[ext]

2.5 检验安装¶

运行以下代码来检验 maliang 是否安装成功：

pip show maliang

若运行无误，则可以在终端输出中看到当前 maliang 的版本。

三、体验最新功能¶

有些功能可能并未存在于当前最新版的 maliang 中，这就需要下载安装最新提交的版本，其安装方式并不是直接同 PyPI 上下载，而是克隆存储库后再下载的。

下面是安装命令：

1
2
3

git clone https://github.com/Xiaokang2022/maliang.git
cd maliang
pip install . #(1)!

1. 当然，你也可以这样写

   pip install .[opt]
   

   或者

   pip install .[ext]
   

另附：如果无法访问 GitHub，可使用镜像源同名仓库的地址：(1)

1. 镜像源数据一般会在 24 小时内同步，可能更新不及时，一切以 GitHub 的数据为准！

• Gitee（首选镜像源）:

1
2
3

git clone https://gitee.com/Xiaokang2022/maliang.git
cd maliang
pip install .

• GitCode:

1
2
3

git clone https://gitcode.com/Xiaokang2022/maliang.git
cd maliang
pip install .