AWS Allowlister 项目教程

AWS Allowlister 项目教程

aws-allowlister Automatically compile an AWS Service Control Policy that ONLY allows AWS services that are compliant with your preferred compliance frameworks. 项目地址: https://gitcode.com/gh_mirrors/aw/aws-allowlister

1. 项目目录结构及介绍

aws-allowlister/
├── examples/
├── test/
├── utils/
├── .gitattributes
├── .gitignore
├── .pylintrc
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── LICENSE
├── MANIFEST.in
├── Makefile
├── Pipfile
├── Pipfile.lock
├── README.md
├── SECURITY.md
├── setup.cfg
├── setup.py

目录结构介绍

• examples/: 包含项目的示例代码和配置文件。
• test/: 包含项目的测试代码。
• utils/: 包含项目的实用工具代码。
• .gitattributes: Git 属性文件，用于指定文件的属性。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• .pylintrc: Pylint 配置文件，用于配置代码检查工具 Pylint。
• CODEOWNERS: 代码所有者文件，指定哪些人负责哪些文件。
• CODE_OF_CONDUCT.md: 行为准则文件，规定项目参与者的行为规范。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 用于指定在打包时需要包含的文件。
• Makefile: 用于自动化构建和测试的 Makefile 文件。
• Pipfile: Pipenv 配置文件，用于管理项目的依赖。
• Pipfile.lock: Pipenv 锁定文件，记录当前依赖的具体版本。
• README.md: 项目说明文件，包含项目的概述、安装和使用说明。
• SECURITY.md: 安全策略文件，包含项目的安全相关信息。
• setup.cfg: 项目配置文件，包含项目的元数据和配置选项。
• setup.py: Python 项目安装脚本。

2. 项目启动文件介绍

项目的主要启动文件是 setup.py。这个文件用于安装和管理项目的依赖，并且可以通过以下命令来安装项目：

pip3 install aws-allowlister

安装完成后，可以通过以下命令来生成 AWS Service Control Policy (SCP)：

aws-allowlister generate

3. 项目配置文件介绍

setup.cfg

setup.cfg 是项目的配置文件，包含项目的元数据和配置选项。以下是 setup.cfg 的一个示例：

[metadata]
name = aws-allowlister
version = 1.0.0
description = Automatically compile an AWS Service Control Policy that ONLY allows AWS services that are compliant with your preferred compliance frameworks.
author = Salesforce
author_email = example@salesforce.com
license = MIT

[options]
packages = find:
install_requires =
    boto3
    click
    requests

Pipfile

Pipfile 是 Pipenv 的配置文件，用于管理项目的依赖。以下是 Pipfile 的一个示例：

[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
boto3 = "*"
click = "*"
requests = "*"

[dev-packages]
pylint = "*"

.pylintrc

.pylintrc 是 Pylint 的配置文件，用于配置代码检查工具 Pylint。以下是 .pylintrc 的一个示例：

[MASTER]
disable = missing-docstring, invalid-name

[MESSAGES CONTROL]
disable =
    C0111,  # missing-docstring
    C0103   # invalid-name

通过这些配置文件，可以确保项目的依赖管理、代码质量和安装过程的一致性。

aws-allowlister Automatically compile an AWS Service Control Policy that ONLY allows AWS services that are compliant with your preferred compliance frameworks. 项目地址: https://gitcode.com/gh_mirrors/aw/aws-allowlister