Globox 项目使用教程
1. 项目的目录结构及介绍
globox/
├── src/
│ └── globox/
│ ├── __init__.py
│ ├── bounding_box.py
│ ├── annotation.py
│ └── ...
├── tests/
│ └── globox_test_data/
│ └── ...
├── .gitignore
├── .gitmodules
├── pre-commit-config.yaml
├── CODE_OF_CONDUCT.md
├── LICENSE.txt
├── README.md
├── pyproject.toml
└── uv.lock
- src/globox/: 包含项目的主要源代码,如
bounding_box.py
和annotation.py
等。 - tests/: 包含项目的测试数据和测试脚本。
- .gitignore: 指定 Git 忽略的文件和目录。
- .gitmodules: 定义 Git 子模块。
- pre-commit-config.yaml: 配置预提交钩子。
- CODE_OF_CONDUCT.md: 项目的行为准则。
- LICENSE.txt: 项目的开源许可证。
- README.md: 项目的介绍和使用说明。
- pyproject.toml: 项目的配置文件,定义了项目的依赖和构建工具。
- uv.lock: 项目的依赖锁定文件。
2. 项目的启动文件介绍
项目的主要启动文件是 src/globox/__init__.py
,它包含了项目的初始化代码和主要功能模块的导入。
3. 项目的配置文件介绍
-
pyproject.toml: 该文件定义了项目的依赖和构建工具。例如:
[tool.poetry] name = "globox" version = "0.1.0" description = "A package to read and convert object detection datasets" authors = ["laclouis5 <your-email@example.com>"] [tool.poetry.dependencies] python = "^3.7" numpy = "^1.19.5" pandas = "^1.2.4" [tool.poetry.dev-dependencies] pytest = "^6.2.4"
-
uv.lock: 该文件锁定了项目的依赖版本,确保在不同环境中安装相同的依赖版本。
通过以上介绍,您可以更好地理解和使用 Globox 项目。