Skip to content

Latest commit

 

History

History
151 lines (103 loc) · 7.43 KB

README.zh-TW.md

File metadata and controls

151 lines (103 loc) · 7.43 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