Skip to content

Latest commit

 

History

History
151 lines (103 loc) · 7.72 KB

README.de.md

File metadata and controls

151 lines (103 loc) · 7.72 KB
Raw

Threagile-Builder

Threagile Builder
CI/CD CI - TestCD - Build
Paket PyPI - VersionPyPI - Python Version
Meta Hatch projectcode style - blacktypes - MypyLicense - MITGitHub Sponsors

AblockbasiertNo-Code-Webanwendung zum ErstellenthreagilYAML-Dateien

Zusammenfassung

Bringen Sie Ihren Code auf Ihrem eigenen System zum Laufen.

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

  1. Installationsprozess:

    $ 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. Softwareabhängigkeiten

  3. Neueste Veröffentlichungen

  4. API-Referenzen

  5. Erstellen und testen:

    Um Ihren Code zu erstellen, verwenden Sie:

    $ cd threagile-builder
$ hatch build

    Um KI für Pull-Request-Reviews zu verwenden, verwenden Sie:

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

    Um die Anwendung auszuführen, verwenden Sie:

    Linux:

    $ export SECRET_KEY="secret"

    Windows:

    $ setx SECRET_KEY secret

    Dann:

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

    Navigieren Sie dann zuhttp://127.0.0.1:5000/in Ihrem Webbrowser.

    Um Tests auszuführen, verwenden Sie:

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

API-Dokumentation

Navigieren Sie zuhttp://127.0.0.1:5000/docsin Ihrem Webbrowser oder laden Sie openapi.json herunter vonhttp://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-builder

Versionsquelle

  • Derhatch-vcsDas Versionsquellen-Plugin bestimmt die Projektversion mithilfe von Git-Tags

Umgebungen

  • Ordentlich in einem Standalone definierthatch.toml
  • DertestMatrix verwendet dieLukencontainerPlugin zum Ausführen jeder Umgebung in Docker-Containern; Die Verwendung ist in der zu sehenprüfenGitHub-Workflow

Bauen

  • Alle Build-Ziele verwenden diehatch-vcsErstellen Sie ein Hook-Plugin, um ein zu versenden_version.pyDatei, damit die Version zur Laufzeit verwendet werden kann
  • Räder verwenden diehatch-mypycBuild-Hook-Plugin, mit dem zunächst der gesamte Code kompiliert werden sollMypyc
  • DerbauenDer GitHub-Workflow zeigt, wie Sie:
    • verwendencibuildwheelbinäre Räder für jede Plattform zu verteilen
    • Benutze dieAppbuild target zum Erstellen eigenständiger Distributionen für jede Plattform

Lizenz

threagile-builderwird gemäß den Bedingungen der verteiltMITLizenz.

100 - Einführung

SehenREADME.md

200 – Anforderungen

SehenREADME.md

300 – Erstellen unserer Anwendung

SehenREADME.md

400 – Fazit

See README.md