check-manifest 项目教程
1. 项目的目录结构及介绍
check-manifest 项目的目录结构如下:
check-manifest/
├── .github/
│ └── workflows/
│ └── ci.yml
├── check_manifest/
│ ├── __init__.py
│ ├── check_manifest.py
│ └── ...
├── tests/
│ ├── __init__.py
│ ├── test_check_manifest.py
│ └── ...
├── .gitignore
├── .travis.yml
├── LICENSE
├── MANIFEST.in
├── README.rst
├── setup.cfg
├── setup.py
└── tox.ini
目录介绍:
.github/workflows/
: GitHub Actions 的工作流配置文件。check_manifest/
: 包含项目的主要代码文件。tests/
: 包含项目的测试代码文件。.gitignore
: Git 忽略文件配置。.travis.yml
: Travis CI 配置文件。LICENSE
: 项目许可证文件。MANIFEST.in
: 用于指定在源代码分发中包含的文件。README.rst
: 项目说明文档。setup.cfg
: 项目配置文件。setup.py
: 项目安装脚本。tox.ini
: Tox 配置文件。
2. 项目的启动文件介绍
项目的启动文件是 check_manifest/check_manifest.py
。这个文件包含了主要的逻辑和功能,用于检查 Python 源代码包中的 MANIFEST.in
文件是否完整。
3. 项目的配置文件介绍
setup.cfg
setup.cfg
是一个配置文件,用于配置 setuptools
的行为。以下是一些常见的配置项:
[metadata]
name = check-manifest
version = attr: check_manifest.__version__
description = Tool to check the completeness of MANIFEST.in for Python packages
long_description = file: README.rst
license = MIT
author = Marius Gedminas
author_email = marius@pov.lt
url = https://github.com/mgedmin/check-manifest
classifiers =
Development Status :: 5 - Production/Stable
Intended Audience :: Developers
License :: OSI Approved :: MIT License
Programming Language :: Python
Programming Language :: Python :: 3
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
[options]
packages = find:
install_requires =
setuptools
setuptools-scm
[options.entry_points]
console_scripts =
check-manifest = check_manifest.check_manifest:main
[check-manifest]
ignore =
.travis.yml
.github/workflows/ci.yml
tox.ini
tox.ini
是用于配置 Tox 的文件,Tox 是一个用于自动化测试的工具。以下是一些常见的配置项:
[tox]
envlist = py36,py37,py38,py39
skipsdist = true
[testenv]
deps =
pytest
commands =
pytest
MANIFEST.in
MANIFEST.in
文件用于指定在源代码分发中包含的文件。以下是一些常见的配置项:
include *.rst
include *.py
include tox.ini
通过这些配置文件,可以确保项目的正确安装和测试。