Skip to content

Latest commit

 

History

History
151 lines (103 loc) · 7.41 KB

README.zh-CN.md

File metadata and controls

151 lines (103 loc) · 7.41 KB

威胁建造者

威胁建造者

持续集成/持续交付 CI - TestCD - Build
包裹 PyPI - VersionPyPI - Python Version
Hatch projectcode style - blacktypes - MypyLicense - MITGitHub Sponsors

一个基于块的创建无代码 Web 应用程序威胁性的YAML 文件

执行摘要

在您自己的系统上启动并运行您的代码。

笔记: 确保您满足要求.

  1. 安装过程:

    $ cd threagile-builder
    $ hatch --version # optional, will print the version of our package to the terminal without modifying the source directory (e.g. `0.0.1`).
    # Without hatch: $ python src/threagile_builder/app.py
    $ hatch env create # optional, if the default env already exists you will be told
    $ hatch shell # spawn a shell within an environment
    (threagile-builder) $ pip show threagile-builder # optional, shows the project details, here 'threagile-builder', from `pyproject.toml`
    # Name: threagile-builder
    # Version: 0.0.1 # it takes this from src/threagile_builder/__about__.py
    # ...
    (threagile-builder) $ python -c "import sys;print(sys.executable)" # optional, see where your environment's python is located
    (threagile-builder) $ pip install --upgrade pip # optional, the `run` command allows you to execute commands in an environment as if you had already entered it.
    (threagile-builder) $ pip install -r requirements.txt # pipx won't do this
    (threagile-builder) $ python -m setuptools_scm # optional, display the version of our package and perform any side-effects like writing to a file. (here: `_version.py`)
    (threagile-builder) $ python src/threagile_builder/app.py # starts the app
    (threagile-builder) $ exit # optional, type `exit` to leave the environment
  2. 软件依赖性

  3. 最新版本

  4. API参考

  5. 构建和测试:

    要构建您的代码,请使用:

    $ cd threagile-builder
    $ hatch build

    要使用 AI 进行拉取请求审查,请使用:

    https://app.coderabbit.ai/dashboard(使用phpstan.neon)

    要运行该应用程序,请使用:

    Linux:

    $ export SECRET_KEY="secret"

    视窗:

    $ setx SECRET_KEY secret

    然后:

    $ cd threagile-builder
    # Without hatch: $ python src/threagile_builder/app.py
    $ hatch run python src/threagile_builder/app.py

    然后,导航至http://127.0.0.1:5000/在您的网络浏览器中。

    要运行测试,请使用:

    $ cd threagile-builder
    $ pip install pytest # optional
    $ pytest tests/

API文档

导航至http://127.0.0.1:5000/docs在您的网络浏览器中,或从以下位置下载 openapi.jsonhttp://127.0.0.1:5000/openapi.json.

指标

让 Prometheus 这样的工具刮擦http://127.0.0.1:9464/metrics.

新的

目录

安装

pip install threagile-builder

版本来源

  • 孵化VCS版本源插件使用 Git 标签确定项目版本

环境

  • 整齐地定义在一个独立的hatch.toml
  • test矩阵使用孵化集装箱用于运行 Docker 容器内每个环境的插件;用法可以在测试GitHub 工作流程

建造

  • 所有构建目标都使用孵化VCS构建钩子插件来发送_version.py文件,以便可以在运行时使用该版本
  • 轮子使用孵化 mypyc构建钩子插件以首先编译所有代码Mypyc
  • 建造GitHub 工作流程展示了如何:
    • 使用cibuildwheel为每个平台分发二进制轮子
    • 使用应用程序构建目标为每个平台构建独立发行版

执照

threagile-builder是根据以下条款分发的执照。

100 - 简介

README.md

200 - 要求

README.md

300 - 构建我们的应用程序

README.md

400 - 结论

README.md