Skip to content

Latest commit

 

History

History
176 lines (112 loc) · 6.46 KB

README.de.md

File metadata and controls

176 lines (112 loc) · 6.46 KB
Raw

ms-team-tickertape

MS Teams-Tickerband

Slugline

Zusammenfassung

Bringen Sie Ihren Code auf Ihrem eigenen System zum Laufen.

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

  1. Installationsprozess:

    $ cd ticker-tape
$ 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/ticker_tape/app.py
$ hatch env create # optional, if the default env already exists you will be told
$ hatch shell # spawn a shell within an environment
(ticker-tape) $ pip show ticker-tape # optional, shows the project details, here 'ticker-tape', from `pyproject.toml`
# Name: ticker-tape
# Version: 0.0.1 # it takes this from src/ticker_tape/__about__.py
# ...
(ticker-tape) $ python -c "import sys;print(sys.executable)" # optional, see where your environment's python is located
(ticker-tape) $ pip install --upgrade pip # optional, the `run` command allows you to execute commands in an environment as if you had already entered it.
(ticker-tape) $ pip install -r requirements.txt # pipx won't do this
(ticker-tape) $ python -m setuptools_scm # optional, display the version of our package and perform any side-effects like writing to a file. (here: `_version.py`)
(ticker-tape) $ exit # optional, type `exit` to leave the environment

    **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 packen. Dieser Paketordner ist in aufgeführt.gitignoreum zu vermeiden, dass man sich an Git bindet.

    Die gesamte Einrichtung sollte inzwischen fertig sein. Sie müssen also nur noch Folgendes tun: 1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm run build

    Dadurch wird das erstelltapp.jsDatei - die alle Komponenten enthält - in/src/ticker_tape/static/js/.

    Entwicklung mit Webpack:Wenn Sie Ihre Website noch entwickeln, in aseparate Terminalsitzung, nachdem Sie den oben genannten Installationsprozess befolgt haben, gehen Sie wie folgt vor: 1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm run watch

    Dies wird - in der separaten Terminalsitzung (d. h.background) – lädt die von Ihnen vorgenommenen Änderungen ständig in die entsprechenden Dateien, während Sie diese Änderungen weiterhin vornehmen können – in der ersten Terminalsitzung (d. h.foreground). Sie müssen Ihre Quellen also nicht nach jeder Bearbeitung neu erstellen, dies geschieht automatisch!

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

    Stellen Sie sicher, dass Sie Ihre Webseite beim Testen mit Backend-Funktionen wie folgt ausführen: 1)(ticker-tape) $ cd src/ticker_tape2)(ticker-tape) $ python app.py

    Prüfen

    Testen Sie die Anwendung (Frontend) auf diese Weise:

    1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm test5)(ticker-tape) $ npm test -- --coverage

    Laufen:

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

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

  2. Softwareabhängigkeiten

  3. Neueste Veröffentlichungen

  4. API-Referenzen

  5. Erstellen und testen:

    Um Ihren Code zu erstellen, verwenden Sie:

    $ cd ticker-tape
$ hatch build

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

    https://app.coderabbit.ai/dashboard

    Um die Anwendung auszuführen, verwenden Sie:

    Linux:

    $ export SECRET_KEY="secret"

    Windows:

    $ setx SECRET_KEY secret

    Dann:

    $ cd ticker-tape
# Without hatch: $ python src/ticker_tape/app.py
$ hatch run python src/ticker_tape/app.py

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

    Um Tests auszuführen, verwenden Sie:

    $ cd ticker-tape
$ 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 ticker-tape

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

ticker-tapewird gemäß den Bedingungen der verteiltMITLizenz.

100 - Einführung

SehenREADME.md

200 – Anforderungen

SehenREADME.md

300 – Erstellen unserer Anwendung

SehenREADME.md

400 – Fazit

SehenREADME.md