libsast 项目教程

libsast 项目教程

libsast Generic SAST Library 项目地址: https://gitcode.com/gh_mirrors/li/libsast

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

libsast 项目的目录结构如下：

libsast/
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── poetry.lock
├── pyproject.toml
├── tox.ini

目录结构介绍

• tests/: 包含项目的测试文件。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的许可证文件，libsast 使用 GNU Lesser General Public License v2 (LGPLv2)。
• README.md: 项目的介绍文件，包含项目的概述、安装和使用说明。
• poetry.lock: 锁定依赖版本的文件，用于确保项目在不同环境中的一致性。
• pyproject.toml: 项目的配置文件，包含项目的元数据和构建系统的要求。
• tox.ini: 用于配置 tox 自动化测试工具的文件。

2. 项目的启动文件介绍

libsast 项目的启动文件是 pyproject.toml。这个文件定义了项目的元数据、依赖项、构建系统和开发工具的配置。

pyproject.toml 文件内容示例

[tool.poetry]
name = "libsast"
version = "1.0.2"
description = "A generic SAST core built on top of sgrep and regex"
authors = ["Ajin Abraham <ajin25@gmail.com>"]
license = "LGPLv2"

[tool.poetry.dependencies]
python = "^3.6"

[tool.poetry.dev-dependencies]
pytest = "^5.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

启动文件介绍

• [tool.poetry]: 定义项目的元数据，如项目名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 定义项目的依赖项，指定所需的 Python 版本和其他依赖库。
• [tool.poetry.dev-dependencies]: 定义开发环境所需的依赖项，如测试框架 pytest。
• [build-system]: 定义构建系统的要求，指定构建后端为 poetry.core.masonry.api。

3. 项目的配置文件介绍

libsast 项目的主要配置文件是 pyproject.toml，它包含了项目的元数据、依赖项和构建系统的配置。此外，项目还包含其他配置文件如 .gitignore 和 tox.ini。

pyproject.toml 配置文件介绍

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的简要描述。
• authors: 项目的作者信息。
• license: 项目的许可证类型。
• dependencies: 项目运行所需的依赖项。
• dev-dependencies: 开发环境所需的依赖项。
• build-system: 构建系统的要求和配置。

.gitignore 配置文件介绍

.gitignore 文件用于指定 Git 版本控制系统忽略的文件和目录，避免将不必要的文件提交到版本库中。

tox.ini 配置文件介绍

tox.ini 文件用于配置 tox 自动化测试工具，定义测试环境、依赖项和测试命令。

[tox]
envlist = py36,py37,py38

[testenv]
deps =
    pytest
commands =
    pytest tests/

• envlist: 定义测试环境列表，如 Python 3.6、3.7 和 3.8。
• deps: 定义测试环境所需的依赖项，如 pytest。
• commands: 定义测试命令，如运行 pytest 进行测试。

通过以上配置文件，libsast 项目可以实现依赖管理、构建和自动化测试等功能。

libsast Generic SAST Library 项目地址: https://gitcode.com/gh_mirrors/li/libsast