Skip to content

Latest commit

 

History

History
218 lines (146 loc) · 11.6 KB

README.es.md

File metadata and controls

218 lines (146 loc) · 11.6 KB

monitoreo de la espía

Monitoreo de la espía
CI/CD CI - TestCD - Build
Paquete PyPI - VersionPyPI - Python Version
Meta Hatch projectcode style - blacktypes - MypyLicense - MITGitHub Sponsors

Una aplicación web para crear paneles paraEspeluznante.

Resumen ejecutivo

Poner en funcionamiento su código en su propio sistema.

Nota: Elpyproject.toml¡El archivo debe estar en la raíz del repositorio!

Nota: Asegúrese de cumplir con elrequisitos.

  1. Proceso de instalación:

    $ 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`)

    **Empaque su sitio con Webpack:**Una vez que tenga un sitio web que sea lo suficientemente bueno para usar, debe empaquetar la aplicación con Webpack. Esta carpeta de paquete se enumera en.gitignorepara evitar que se comprometa con GIT.

    Toda la configuración debería estar lista para ahora, así que todo lo que tiene que hacer: 1)(.hatch) $ cd src/threagile_monitoring2)(.hatch) $ npm install3)(.hatch) $ npm run build

    Esto creará elvendors.#####.jsymain.#####.jsarchivos, que contienen todos los componentes, en/src/threagile_monitoring/static/js/.

    Desarrollo con Webpack:Si todavía está desarrollando su sitio web, en unSesión de terminal separada, después de haber seguido el proceso de instalación anterior, haga esto: 1)cd ../# ir a la raíz del repositorio 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

    Esto lo hará: en la sesión terminal separada (es decir,background) - Cargue constantemente los cambios que realiza en los archivos apropiados, mientras que puede continuar haciendo esos cambios, en la sesión de terminal inicial (es decir,foreground). Por lo tanto, no tiene que construir sus fuentes después de cada edición, ¡se cuida automáticamente!

    Para ver los cambios, simplemente guarde y vuelva a cargar su navegador (generalmente con F5).

    Uso de torcer para el desarrollo de la interfaz de usuario

    Asumires una herramienta poderosa para el desarrollo interactivo de la interfaz de usuario que se integra con su proyecto.

    1. Configuración de integración:

      • Asegúrese de que su interfaz esté funcionando (npm run watch)
      • Inicie su servidor de backend (python app.py)
      • Iniciar a P "en su propia aplicación
      • Conecte Plook a su frontend en funcionamiento

    2. Mejores prácticas:

      • Hacer pequeños cambios incrementales
      • Los cambios de prueba inmediatamente en el navegador
      • Revisar el código generado antes de comprometerse
      • Mantenga Plook y su frontend en sincronización
      • Utilice el control de versiones para todos los cambios generados por P "

    3. Configuración:

      • Perspect detectará la estructura de su proyecto
      • Hará cambios directamente en sus archivos de origen
      • Los cambios se reflejan inmediatamente debido a Webpack Watch
      • Su API de backend permanece accesible durante el desarrollo

    Nota: Siempre asegúrese de que su interfaz se esté ejecutando antes de comenzar el desarrollo de P ". Esto permite una vista previa en tiempo real de sus cambios.

    Asegúrese, para ejecutar su página web al probar con funciones de backend, de la siguiente manera: 1)cd ../../../# ir a la raíz del repositorio 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ python app.py

    Prueba

    Pruebe la aplicación (frontend) de esta manera: 1)cd ../# ir a la raíz del repositorio 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ npm install5)(.hatch) $ npm test6)(.hatch) $ npm test -- --coverage

    Correr:

    Si no se desarrolla, ejecute la aplicación (backend y frontend simultáneamente) de esta manera:

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

  2. Dependencias de software

  3. Últimos lanzamientos

  4. Referencias de API

  5. Construir y probar:

    Para construir su código, use:

    $ cd threagile-monitoring
$ hatch build

    Para usar AI para revisiones de solicitudes de extracción, use:

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

    Para ejecutar la aplicación, use:

    Linux:

    $ export SECRET_KEY="secret"

    Windows:

    $ setx SECRET_KEY secret

    Entonces:

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

    Entonces, navegue ahttp://127.0.0.1:5000/en su navegador web.

    Para ejecutar pruebas, use:

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

Documentación de API

Navegar porhttp://127.0.0.1:5000/docsEn su navegador web, o descargue el OpenApi.json desdehttp://127.0.0.1:5000/openapi.json.

Métrica

Deje que una herramienta como Prometheus Scrapehttp://127.0.0.1:9464/metrics.

NUEVO

Tabla de contenido

Instalación

pip install threagile-monitoring

Fuente de la versión

  • ElHatch-VCSEl complemento de la fuente de la versión determina la versión del proyecto utilizando etiquetas git

Entornos

  • Definido perfectamente en unhatch.toml
  • Eltestmatriz usa elcontenedorescomplemento para ejecutar cada entorno dentro de los contenedores Docker; el uso se puede ver en elpruebaFlujo de trabajo de Github

Construir

  • Todos los objetivos de construcción usan elHatch-VCScomplemento de gancho de compilación para enviar un_version.pyarchivo para que la versión se pueda usar en tiempo de ejecución
  • Las ruedas usan elhatch-mypycBuild Hook Plugin para compilar primero todo el código conMypyc
  • ElconstruirEl flujo de trabajo de GitHub muestra cómo:
    • usarcibuildwheelpara distribuir ruedas binarias para cada plataforma
    • usar elaplicaciónConstruir un objetivo para construir distribuciones independientes para cada plataforma

Licencia

threagile-monitoringse distribuye bajo los términos delCONlicencia.

100 - Introducción

VerREADME.md

200 - Requisitos

VerREADME.md

300 - Construyendo nuestra aplicación

VerREADME.md

400 - Conclusión

VerREADME.md