prettymaps

环境要求

• Python 3.11 或更高版本
• 可用的 pip 包管理工具
• 已安装 Git（Colab 方式安装时需要）
• 运行前端需安装 streamlit
• 运行教程需安装 marimo（已包含在 requirements.txt 中）

安装与启动步骤

1. 1确认 Python 版本

   prettymaps 要求 Python 3.11+，先确认本机 Python 版本满足要求，否则升级后再安装。

   python --version

   复制

2. 2安装 prettymaps

   使用 pip 从 PyPI 安装 prettymaps 库，这是本机安装的官方方式。

   pip install prettymaps

   复制

3. 3Colab 方式安装

   在 Google Colaboratory 中改用仓库源码安装，单元里命令需带感叹号，装完必须重启运行时。

   pip install -e "git+https://github.com/marceloprates/prettymaps#egg=prettymaps"

   复制

4. 4重启 Colab 运行时

   Colab 安装完成后，通过 Runtime -> Restart Runtime 重启运行时，再导入 prettymaps，否则可能导入失败。

5. 5运行前端应用

   先进入 prettymaps 仓库目录，再执行 streamlit 命令启动前端，README 使用仓库内的 app.py。

   streamlit run app.py

   复制

6. 6安装 marimo 教程

   marimo 已列在 requirements.txt 中，若要本地跑教程需额外安装。

   pip install marimo

   复制

如何确认成功

执行 import prettymaps 无报错；运行 streamlit run app.py 后浏览器能打开它输出的本地地址页面。

常见问题

注意事项

• 必须保留图中对 prettymaps 仓库与 OpenStreetMap 的署名信息。
• 项目许可证为 GNU AGPL v3.0，修改分发时需公开源码并保留声明。
• README 未提供命令行绘图接口示例，绘图请在 Python 代码或 streamlit 前端中操作。
• 作者声明反对 NFT 用途，使用时请留意相关说明。