开源项目 sample-namespace-packages
使用教程
1. 项目的目录结构及介绍
sample-namespace-packages/
├── LICENSE
├── README.md
├── native/
│ ├── mynamespace/
│ │ ├── __init__.py
│ │ ├── subpackage_a/
│ │ │ ├── __init__.py
│ │ │ └── module_a.py
│ │ └── subpackage_b/
│ │ ├── __init__.py
│ │ └── module_b.py
│ ├── pyproject.toml
│ └── setup.py
├── pkgutil/
│ ├── mynamespace/
│ │ ├── __init__.py
│ │ ├── subpackage_a/
│ │ │ ├── __init__.py
│ │ │ └── module_a.py
│ │ └── subpackage_b/
│ │ ├── __init__.py
│ │ └── module_b.py
│ ├── pyproject.toml
│ └── setup.py
└── pkg_resources/
├── mynamespace/
│ ├── __init__.py
│ ├── subpackage_a/
│ │ ├── __init__.py
│ │ └── module_a.py
│ └── subpackage_b/
│ ├── __init__.py
│ └── module_b.py
├── pyproject.toml
└── setup.py
目录结构介绍
native/
: 包含使用原生命名空间包的示例。pkgutil/
: 包含使用pkgutil
风格命名空间包的示例。pkg_resources/
: 包含使用pkg_resources
风格命名空间包的示例。mynamespace/
: 命名空间包目录,包含子包subpackage_a
和subpackage_b
。pyproject.toml
: 项目配置文件。setup.py
: 项目安装脚本。
2. 项目的启动文件介绍
每个示例目录 (native/
, pkgutil/
, pkg_resources/
) 中都有一个 setup.py
文件,这是项目的启动文件。setup.py
文件用于配置和安装项目。
setup.py
文件示例
from setuptools import setup, find_namespace_packages
setup(
name='mynamespace-subpackage-a',
packages=find_namespace_packages(where='src/', include=['mynamespace.*']),
package_dir={'': 'src'}
)
3. 项目的配置文件介绍
每个示例目录 (native/
, pkgutil/
, pkg_resources/
) 中都有一个 pyproject.toml
文件,这是项目的配置文件。pyproject.toml
文件用于定义项目的构建系统和其他配置。
pyproject.toml
文件示例
[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "mynamespace-subpackage-a"
version = "0.0.1"
description = "A sample namespace package"
authors = [
{ name="Example Author", email="author@example.com" }
]
dependencies = []
以上是 sample-namespace-packages
项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用该项目。