Typer-CLI 项目教程

Typer-CLI 项目教程

typer-cliRun Typer scripts with completion, without having to create a package, using Typer CLI.项目地址:https://gitcode.com/gh_mirrors/ty/typer-cli

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

Typer-CLI 项目的目录结构如下：

typer-cli/
├── scripts/
├── tests/
├── typer_cli/
│   ├── __init__.py
│   ├── main.py
│   └── ...
├── .coveragerc
├── .gitignore
├── LICENSE
├── README.md
├── SECURITY.md
├── mypy.ini
├── pyproject.toml
├── release-notes.md
└── requirements.txt

目录介绍

• scripts/: 包含一些用于开发和测试的脚本。
• tests/: 包含项目的测试文件。
• typer_cli/: 项目的主要代码目录，包含核心功能实现。
  • __init__.py: 初始化文件。
  • main.py: 项目的主入口文件。
• .coveragerc: 配置代码覆盖率测试的文件。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• SECURITY.md: 项目的安全相关说明。
• mypy.ini: 配置静态类型检查工具 mypy 的文件。
• pyproject.toml: 项目的构建和依赖配置文件。
• release-notes.md: 发布说明文档。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的启动文件是 typer_cli/main.py。这个文件包含了项目的核心逻辑和命令行接口的定义。

主要功能

• 定义命令行接口：使用 Typer 库定义命令行接口，包括命令、选项和参数。
• 处理命令行输入：根据用户输入执行相应的功能。
• 提供命令行帮助信息：生成命令行帮助文档，方便用户使用。

3. 项目的配置文件介绍

项目的配置文件主要包括 pyproject.toml 和 requirements.txt。

pyproject.toml

pyproject.toml 是一个标准的 Python 项目配置文件，用于定义项目的构建系统和依赖。

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "typer-cli"
version = "0.12.3"
description = "Run Typer scripts with completion without having to create a package using Typer CLI"
authors = [
    { name="Sebastián Ramírez", email="tiangolo@gmail.com" }
]
license = { file="LICENSE" }
readme = "README.md"
requires-python = ">=3.7"
dependencies = [
    "typer"
]

requirements.txt

requirements.txt 列出了项目运行所需的 Python 包及其版本。

typer==0.12.3

这两个配置文件共同确保了项目的正确构建和运行。

typer-cliRun Typer scripts with completion, without having to create a package, using Typer CLI.项目地址:https://gitcode.com/gh_mirrors/ty/typer-cli