surveillance des risques
| CI/CD |   |
| Emballer |   |
| Méta |      |
Une application web pour créer des tableaux de bord pourMenaçant.
Résumé exécutif
Faire en sorte que votre code soit opérationnel sur votre propre système.
Note: Lepyproject.tomlle fichier doit être à la racine du référentiel !
Note: Assurez-vous de remplir lesexigences.
-
Processus d'installation :
$ 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`)
**Packagez votre site avec webpack :**Une fois que vous disposez d’un site Web suffisamment performant pour que vous puissiez l’utiliser, vous devez empaqueter l’application avec webpack. Ce dossier de package est répertorié dans
.gitignorepour éviter qu'il soit engagé dans git.Toute la configuration devrait être prête maintenant, il vous suffit donc de : 1)
(.hatch) $ cd src/threagile_monitoring2)(.hatch) $ npm install3)(.hatch) $ npm run buildCela créera le
app.jsfichier - qui contient tous les composants - dans/src/threagile_monitoring/static/js/.Développement avec webpack :Si vous développez encore votre site Web, dans unsession terminale séparée, après avoir suivi le processus d'installation ci-dessus, faites ceci : 1)
cd ../# va à la racine du dépôt 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 watchCela sera - dans la session de terminal séparée (c'est-à-dire
background) - chargez constamment les modifications que vous apportez dans les fichiers appropriés, tandis que vous pouvez continuer à apporter ces modifications - lors de la session initiale du terminal (c'est-à-direforeground). Vous n’avez donc pas besoin de construire vos sources après chaque édition, cela est pris en charge automatiquement !Pour voir les modifications, enregistrez et rechargez simplement votre navigateur (généralement avec F5).
Assurez-vous d'exécuter votre page Web lors des tests avec les fonctions backend, comme suit : 1)
cd ../# va à la racine du dépôt 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ python app.pyTest
Testez l'application (frontend) de cette façon : 1)
cd ../# va à la racine du dépôt 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ npm install5)(.hatch) $ npm test6)(.hatch) $ npm test -- --coverageCourir:
Si vous ne développez pas, exécutez l'application (backend et frontend simultanément) de cette façon :
$ hatch run python src/threagile_monitoring/app.py # starts the app
-
Dépendances logicielles
-
Dernières versions
-
Références API
-
Construire et tester :
Pour construire votre code, utilisez :
$ cd threagile-monitoring $ hatch buildPour utiliser l'IA pour les révisions de demandes d'extraction, utilisez :
https://app.coderabbit.ai/dashboard(utilise
phpstan.neon)Pour exécuter l'application, utilisez :
Linux :
$ export SECRET_KEY="secret"
Fenêtres :
$ setx SECRET_KEY secret
Alors:
$ cd threagile-monitoring # Without hatch: $ python src/threagile_monitoring/app.py $ hatch run python src/threagile_monitoring/app.py
Ensuite, accédez à
http://127.0.0.1:5000/dans votre navigateur Internet.Pour exécuter des tests, utilisez :
$ cd threagile-monitoring $ pip install pytest # optional $ pytest tests/
Accédez àhttp://127.0.0.1:5000/docsdans votre navigateur Web, ou téléchargez le fichier openapi.json depuishttp://127.0.0.1:5000/openapi.json.
Laissez un outil comme Prometheus gratterhttp://127.0.0.1:9464/metrics.
NOUVEAU
Table des matières
pip install threagile-monitoring- Letrappe-vcsLe plugin source de version détermine la version du projet à l'aide des balises Git
- Bien défini dans un environnement autonome
hatch.toml - Le
testla matrice utilise leconteneurs-écoutillesplugin pour exécuter chaque environnement dans les conteneurs Docker ; l'utilisation peut être vue dans letestFlux de travail GitHub
- Toutes les cibles de build utilisent letrappe-vcsconstruire un plugin hook pour expédier un
_version.pyfichier afin que la version puisse être utilisée au moment de l'exécution - Les roues utilisent letrappe-mypycconstruire un plugin hook pour compiler d'abord tout le code avecMonpyc
- LeconstruireLe workflow GitHub montre comment :
- utiliserroue cibuilddistribuer des roues binaires pour chaque plateforme
- utiliser leapplicationconstruire une cible pour créer des distributions autonomes pour chaque plate-forme
threagile-monitoringest distribué selon les termes duAVEClicence.
VoirREADME.md
VoirREADME.md
VoirREADME.md
VoirREADME.md