py3readiness 项目教程

py3readiness 项目教程

py3readiness Python 3 support graph for most popular packages 项目地址: https://gitcode.com/gh_mirrors/py/py3readiness

1. 项目的目录结构及介绍

py3readiness/
├── src/
│   ├── gitignore
│   ├── travis.yml
│   ├── LICENSE
│   ├── Makefile
│   ├── README.md
│   ├── fabfile.py
│   ├── generate.py
│   ├── index.html
│   ├── requirements.txt
│   ├── results.json
│   ├── wheel.css
│   └── wheel.svg
└── ...

• src/: 项目的主要源代码目录。
  • gitignore: Git 忽略文件配置。
  • travis.yml: Travis CI 配置文件。
  • LICENSE: 项目许可证文件。
  • Makefile: 项目构建文件。
  • README.md: 项目说明文档。
  • fabfile.py: Fabric 脚本文件，用于自动化任务。
  • generate.py: 生成 Python 3 支持图表的脚本文件。
  • index.html: 项目主页 HTML 文件。
  • requirements.txt: 项目依赖文件。
  • results.json: 生成的结果 JSON 文件。
  • wheel.css: 项目样式文件。
  • wheel.svg: 项目图标文件。

2. 项目的启动文件介绍

项目的启动文件是 generate.py。该文件负责生成 Python 3 支持图表，并更新相关的 JSON 文件和 HTML 文件。

主要功能

• 检查 PyPI 包的 Python 3 支持情况：通过 caniusepython3 工具检查指定包是否支持 Python 3。
• 生成 JSON 文件：将检查结果生成 JSON 文件，用于后续的图表展示。
• 更新 HTML 文件：根据生成的 JSON 文件更新项目主页的 HTML 文件。

3. 项目的配置文件介绍

1. travis.yml

Travis CI 配置文件，用于自动化测试和部署。

language: python
python:
  - "3.7"
  - "3.8"
  - "3.9"
install:
  - pip install -r requirements.txt
script:
  - python generate.py

2. Makefile

项目构建文件，包含一些常用的命令。

all: generate

generate:
    python generate.py

clean:
    rm -f results.json

3. requirements.txt

项目依赖文件，列出了项目运行所需的 Python 包。

caniusepython3==7.2.0
requests==2.25.1

4. fabfile.py

Fabric 脚本文件，用于自动化任务。

from fabric.api import task, run

@task
def generate():
    run('python generate.py')

通过以上配置文件，可以自动化项目的构建、测试和部署过程。

py3readiness Python 3 support graph for most popular packages 项目地址: https://gitcode.com/gh_mirrors/py/py3readiness