Skip to main content

A tool to generate travel map.

Project description

旅行地图

这是一个精确到城市旅行地图生成器。 本项目是基于开源项目 pyechart, 生成的中国地图符合法律规范。

GitHub Workflow Status Codecov PyPI PyPI - License PyPI - Python Version GitHub last commit

安装

pip install travel-map

使用

用户需要将旅行信息输入到一个 CSV 文件里,例如

城市,组
北京,旅行
上海,旅行
武汉,居住
香港,中转

文件中城市的名称可以查阅文件

然后运行命令

travel-map --title "我的旅行地图" --output travel_map.html travelled_cities.csv

即可生成标题为我的旅行地图的精确到城市的旅行地图如下

demo

如何贡献

十分欢迎 Fork 本项目! 欢迎修复 bug 或开发新功能。 开发时请遵循以下步骤:

  1. 使用 poetry 作为依赖管理

    克隆项目后,在项目文件夹运行

    poetry install
    
  2. 使用 pre-commit 并遵守 Conventional commits 规范

    安装 pre-commit 并运行

    pre-commit install -t pre-commit -t commit-msg
    

    建议使用 commitizen 提交您的 commits。

  3. 遵循 gitflow 分支管理策略

    安装 git-flow 管理您的分支并运行

    git config gitflow.branch.master main
    git config gitflow.prefix.versiontag v
    git flow init -d
    
  4. PR 代码到 develop 分支

许可证

木兰宽松许可证,第2版 (Mulan Permissive Software License,Version 2)

Copyright (c) 2019 hktkzyx

travel-map is licensed under Mulan PSL v2.

You can use this software according to the terms and conditions of the Mulan PSL v2.

You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2

THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.

See the Mulan PSL v2 for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

travel-map-2.0.0.tar.gz (9.4 kB view hashes)

Uploaded Source

Built Distribution

travel_map-2.0.0-py3-none-any.whl (9.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page