FreeTAKServer 项目安装与使用指南

1. 项目目录结构及介绍

FreeTAKServer 项目的目录结构如下：

FreeTAKServer/
├── FreeTAKServer/
│   ├── Controllers/
│   ├── Models/
│   ├── Views/
│   ├── __init__.py
│   └── ...
├── tests/
├── Dockerfile
├── LICENSE
├── MANIFEST.in
├── README.md
├── README_DOCKER.md
├── REST_APIDoc.md
├── REST_API_InternalDoc.md
├── SECURITY.md
├── compose.yaml
├── docker-run.sh
├── gitDigitalPy.Dockerfile
├── pyproject.toml
├── pytest.ini
├── requirements.txt
├── setup.cfg
├── setup.py
└── sider.yml

目录结构介绍

• FreeTAKServer/: 项目的主目录，包含了项目的核心代码。
  • Controllers/: 包含项目的业务逻辑代码。
  • Models/: 包含项目的对象模型代码。
  • Views/: 包含项目的视图代码。
  • init.py: 初始化文件。
• tests/: 包含项目的测试代码。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 清单文件，用于指定打包时包含的文件。
• README.md: 项目介绍文件。
• README_DOCKER.md: Docker 相关介绍文件。
• REST_APIDoc.md: REST API 文档。
• REST_API_InternalDoc.md: 内部 REST API 文档。
• SECURITY.md: 安全相关文档。
• compose.yaml: Docker Compose 配置文件。
• docker-run.sh: Docker 运行脚本。
• gitDigitalPy.Dockerfile: 用于 DigitalPy 的 Docker 文件。
• pyproject.toml: Python 项目配置文件。
• pytest.ini: pytest 配置文件。
• requirements.txt: 项目依赖文件。
• setup.cfg: 项目配置文件。
• setup.py: 项目安装脚本。
• sider.yml: Sider 配置文件。

2. 项目启动文件介绍

FreeTAKServer 项目的启动文件主要是 setup.py 和 docker-run.sh。

setup.py

setup.py 是 Python 项目的标准安装脚本，用于配置项目的元数据和依赖项。通过运行以下命令可以安装项目：

pip install .

docker-run.sh

docker-run.sh 是一个用于启动 Docker 容器的脚本。通过运行以下命令可以启动项目：

./docker-run.sh

3. 项目配置文件介绍

FreeTAKServer 项目的主要配置文件包括 setup.cfg 和 pyproject.toml。

setup.cfg

setup.cfg 是一个配置文件，用于指定项目的各种配置选项，例如包的元数据、测试配置等。

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于指定项目的构建系统和依赖项。它替代了传统的 setup.py 和 requirements.txt 文件。

通过这些配置文件，用户可以自定义项目的运行环境和行为。