Skip to content

Latest commit

 

History

History
218 lines (146 loc) · 11.6 KB

README.de.md

File metadata and controls

218 lines (146 loc) · 11.6 KB

Dreigile-Überwachung

Überwachung der Dreigile
CI/CD CI - TestCD - Build
Paket PyPI - VersionPyPI - Python Version
Meta Hatch projectcode style - blacktypes - MypyLicense - MITGitHub Sponsors

Eine Webanwendung zum Erstellen von Dashboards fürDreigile.

Zusammenfassung

Lassen Sie Ihren Code in Ihrem eigenen System ausgeführt.

Notiz: Derpyproject.tomlDie Datei sollte sich im Stamm des Repositorys befinden!

Notiz: Stellen Sie sicher, dass Sie die erfüllenAnforderungen.

  1. Installationsprozess:

    $ 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) $ pwd # go to the directory where pyproject.toml resides
(.hatch) $ pip install -e . # install the package in editable mode
(.hatch) $ cd threagile-monitoring # go 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`)

    **Verpacken Sie Ihre Website mit WebPack:**Sobald Sie eine Website haben, die für Sie gut genug ist, müssen Sie die Anwendung mit WebPack verpacken. Dieser Paketordner ist in aufgeführt.gitignoreUm zu vermeiden, dass es Git verpflichtet ist.

    Das gesamte Setup sollte inzwischen fertig sein, also alles, was Sie tun müssen: 1)(.hatch) $ cd src/threagile_monitoring2)(.hatch) $ npm install3)(.hatch) $ npm run build

    Dies erstellt dievendors.#####.jsUndmain.#####.jsDateien - die alle Komponenten enthalten - in/src/threagile_monitoring/static/js/.

    Entwicklung mit Webpack:Wenn Sie noch Ihre Website in a entwickelnseparate TerminalsitzungNachdem Sie den oben genannten Installationsprozess befolgt haben, tun Sie dies: 1)cd ../# Gehen Sie zur Wurzel des Repositorys 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

    Dies gilt - in der separaten Terminalsitzung (d. H.background) - Laden Sie die Änderungen, die Sie vornehmen, ständig in die entsprechenden Dateien, während Sie diese Änderungen in der anfänglichen Terminalsitzung fortsetzen können (d. H.foreground). Sie müssen also nach jeder Bearbeitung keine Quellen erstellen, sondern wird automatisch gepflegt!

    Um die Änderungen zu sehen, speichern und laden Sie Ihren Navigator einfach (normalerweise mit F5).

    Verwenden von Onlook für die UI -Entwicklung

    Onlookist ein leistungsstarkes Tool für die interaktive UI -Entwicklung, das sich in Ihr Projekt integriert.

    1. Integrationssetup:

      • Stellen Sie sicher, dass Ihr Frontend läuft (npm run watch)
      • Starten Sie Ihren Backend -Server (python app.py)
      • Starten Sie Onlook in einer eigenen Anwendung
      • Verbinden Sie Onlook mit Ihrem laufenden Frontend

    2. Best Practices:

      • Nehmen Sie kleine, inkrementelle Änderungen vor
      • Teständerungen sofort im Browser
      • Überprüfen Sie den generierten Code, bevor Sie sich verpflichten
      • Bleiben Sie in Synchronisierung und Ihr Frontend
      • Verwenden Sie die Versionskontrolle für alle von Onlook generierten Änderungen

    3. Konfiguration:

      • Onlook wird die Struktur Ihres Projekts erkennen
      • Es werden Änderungen direkt an Ihren Quelldateien vorgenommen
      • Änderungen werden sofort aufgrund der Webpack -Uhr reflektiert
      • Ihre Backend -API bleibt während der Entwicklung zugänglich

    Notiz: Stellen Sie immer sicher, dass Ihre Frontend vor Beginn der Onlook -Entwicklung läuft. Dies ermöglicht eine Echtzeit-Vorschau Ihrer Änderungen.

    Stellen Sie sicher, dass Sie Ihre Webseite beim Testen mit Backend -Funktionen wie folgt ausführen: 1)cd ../../../# Gehen Sie zur Wurzel des Repositorys 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ python app.py

    Prüfen

    Testen Sie die Anwendung (Frontend) auf diese Weise: 1)cd ../# Gehen Sie zur Wurzel des Repositorys 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ npm install5)(.hatch) $ npm test6)(.hatch) $ npm test -- --coverage

    Laufen:

    Wenn Sie sich nicht entwickeln, führen Sie die Anwendung auf diese Weise aus (Backend und Frontend gleichzeitig):

    $ hatch run python src/threagile_monitoring/app.py # starts the app

  2. Softwareabhängigkeiten

  3. Neueste Veröffentlichungen

  4. API -Referenzen

  5. Bauen und testen:

    Verwenden Sie, um Ihren Code zu erstellen:

    $ cd threagile-monitoring
$ hatch build

    Um AI für Pull -Anfrage -Bewertungen zu verwenden, verwenden Sie:

    https://app.coderabbit.ai/dashboard(Verwendetphpstan.neon)

    Verwenden Sie die Anwendung, um die Anwendung auszuführen:

    Linux:

    $ export SECRET_KEY="secret"

    Fenster:

    $ setx SECRET_KEY secret

    Dann:

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

    Dann navigieren Sie zuhttp://127.0.0.1:5000/in Ihrem Webbrowser.

    Um Tests auszuführen, verwenden Sie:

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

API -Dokumentation

Navigieren zuhttp://127.0.0.1:5000/docsin Ihrem Webbrowser oder laden Sie den OpenAPI.json von herunterhttp://127.0.0.1:5000/openapi.json.

Metriken

Lassen Sie ein Werkzeug wie Prometheus kratzenhttp://127.0.0.1:9464/metrics.

NEU

Inhaltsverzeichnis

Installation

pip install threagile-monitoring

Versionsquelle

  • DerHatch-VCSVersionsquellen -Plugin bestimmt die Projektversion mit Git -Tags

Umgebungen

  • Ordentlich in einem Standalon definierthatch.toml
  • DertestMatrix verwendet dieHatch-ContainerPlugin, um jede Umgebung in Docker -Containern auszuführen; Verwendung ist in der zu sehenprüfenGithub Workflow

Bauen

  • Alle Build -Ziele verwenden dieHatch-VCSBauen Sie Hook -Plugin, um a zu versenden_version.pyDatei so kann die Version zur Laufzeit verwendet werden
  • Räder verwenden dieHatch-MypycBauen Sie das Hook -Plugin auf, um zuerst alle Code mit zu kompilierenMypyc
  • DerbauenGithub Workflow zeigt, wie man:
    • verwendenCibuildwheelBinärräder für jede Plattform verteilen
    • benutze dieAppErstellen Sie das Ziel, um eigenständige Verteilungen für jede Plattform zu erstellen

Lizenz

threagile-monitoringist unter den Bedingungen derMITLizenz.

100 - Einführung

SehenREADME.md

200 - Anforderungen

SehenREADME.md

300 - Aufbau unserer Bewerbung

SehenREADME.md

400 - Schlussfolgerung

SehenREADME.md