Skip to content

Latest commit

 

History

History
193 lines (127 loc) · 9.71 KB

README.zh-TW.md

File metadata and controls

193 lines (127 loc) · 9.71 KB

威脅監控

威脅監控

持續整合/持續交付 CI - TestCD - Build
包裹 PyPI - VersionPyPI - Python Version
Hatch projectcode style - blacktypes - MypyLicense - MITGitHub Sponsors

用於建立儀表板的 Web 應用程式威脅型.

執行摘要

在您自己的系統上啟動並運行您的程式碼。

筆記: 這pyproject.toml檔案應該位於儲存庫的根目錄中!

筆記: 確保您滿足要求.

  1. 安裝過程:

    $ cd threagile-monitoring # start at sub-directory of the repository where the requirements.txt file is kept.
    $ 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_monitoring/app.py
    $ hatch env create # optional, if the default env already exists you will be told
    $ hatch shell # spawn a shell within an environment
    (.hatch) $ cd .. # go one directory up to where pyproject.toml resides
    (.hatch) $ pip install -e . # install the package in editable mode
    (.hatch) $ cd threagile-monitoring # go back to the sub-directory of the repository where the requirements.txt file is kept.
    (.hatch) $ pip show threagile-monitoring # optional, shows the project details, here 'threagile-monitoring', from `pyproject.toml`
    # Name: threagile-monitoring
    # Version: 0.0.1 # it takes this from src/threagile_monitoring/__about__.py
    # ...
    (.hatch) $ python -c "import sys;print(sys.executable)" # optional, see where your environment's python is located
    (.hatch) $ pip install --upgrade pip # optional, the `run` command allows you to execute commands in an environment as if you had already entered it.
    (.hatch) $ pip install -r requirements.txt # pipx won't do this
    (.hatch) $ git tag # check if you already have a verion tagged
    (.hatch) $ git tag -a v0.0.1 -m "Initial release" # optional, if you have no tags yet
    # setuptools_scm displays the version of our package and perform any side-effects like writing to a file. (here: `__about__.py`)

    **使用 webpack 打包您的網站:**一旦你有了一個足夠好的網站可供你使用,你就必須使用 webpack 來打包應用程式。該包資料夾列於.gitignore以避免它被提交給 git。

    現在所有設定都應該準備就緒,因此您需要做的就是: 1)(.hatch) $ cd src/threagile_monitoring2)(.hatch) $ npm install3)(.hatch) $ npm run build

    這將創建app.js文件 - 包含所有組件 - 在/src/threagile_monitoring/static/js/.

    **使用webpack開發:**如果您仍在開發您的網站,單獨的終端會話,按照上述安裝程序後,執行以下操作: 1)cd ../# 前往儲存庫的根目錄 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ sudo chown -R $USER:$(id -gn $USER) ~/.npm5)(.hatch) $ npm install6)(.hatch) $ npm run watch

    這將 - 在單獨的終端會話中(即background) - 不斷地將您所做的更改載入到適當的文件中,同時您可以在初始終端會話中繼續進行這些更改(即foreground)。因此,您不必在每次編輯後建立原始程式碼,它會自動處理!

    要查看更改,只需儲存並重新載入導航器(通常使用 F5)。

    確保在使用後端功能進行測試時運行您的網頁,如下所示: 1)cd ../# 前往儲存庫的根目錄 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ python app.py

    測試

    以這種方式測試應用程式(前端): 1)cd ../# 前往儲存庫的根目錄 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ npm install5)(.hatch) $ npm test6)(.hatch) $ npm test -- --coverage

    跑步:

    如果不進行開發,請按以下方式運行應用程式(同時後端和前端):

    $ hatch run python src/threagile_monitoring/app.py # starts the app 
    
  2. 軟體依賴性

  3. 最新版本

  4. API參考

  5. 建置和測試:

    要建立您的程式碼,請使用:

    $ cd threagile-monitoring
    $ hatch build

    若要使用 AI 進行拉取請求審查,請使用:

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

    要運行該應用程序,請使用:

    Linux:

    $ export SECRET_KEY="secret"

    視窗:

    $ setx SECRET_KEY secret

    然後:

    $ cd threagile-monitoring
    # Without hatch: $ python src/threagile_monitoring/app.py
    $ hatch run python src/threagile_monitoring/app.py

    然後,導航至http://127.0.0.1:5000/在您的網頁瀏覽器中。

    若要執行測試,請使用:

    $ cd threagile-monitoring
    $ 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-monitoring

版本來源

  • 孵化VCS版本來源外掛程式使用 Git 標籤來確定專案版本

環境

  • 整齊地定義在獨立的hatch.toml
  • test矩陣使用孵化貨櫃用於運行 Docker 容器內每個環境的插件;用法可以在測試GitHub 工作流程

建造

  • 所有建置目標都使用孵化VCS建立鉤子插件來發送_version.py文件,以便可以在運行時使用該版本
  • 輪子使用孵化 mypyc建立鉤子插件以首先編譯所有程式碼Mypyc
  • 建造GitHub 工作流程展示如何:
    • 使用cibuildwheel為每個平台分發二進制輪子
    • 使用應用程式建構目標為每個平台建立獨立發行版

執照

threagile-monitoring是根據以下條款分發的 license.

100 - 簡介

README.md

200 - 要求

README.md

300 - 建立我們的應用程式

README.md

400 - 結論

README.md