PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

0.3.1

PyPI

adengine

Engine for Activity Data Extractor

Published25 Apr 2021
Direct dependencies2
Transitive dependenciesNot calculated

README

Version 0.3.1 documentation

ADEngine

pypi.org package version pypi.org python version pypi.org license pypi.org downloads cpt 7.3.0 cpt 7.3.1 cpt 8.0.0

Scroll down for russian language
Прокрутите ниже для русского языка

en-US:

About

This is a python engine for Activity Data Extractor.
It is a special python module, designed to extract data from multiple activity files at the same time.

Installation

  1. Download and install Cisco Packet Tracer
  2. Download and install Activity Data Extractor
  3. Download and install Python
  4. Install engine from PyPI using command python3 -m pip install adengine
  5. Now the engine should be installed and ready to go

Requirements

  • Cisco Packet Tracer 7.3.0, 7.3.1 or 8.0.0.
    It is possible, that engine would run on higher versions on PacketTracer, but this is untested functionality.
  • Activity Data Extractor 1.0.3 and higher.
  • Python 3.8 or higher.
  • OS depends on version of Packet Tracer
    • Ubuntu 18.04 for Cisco Packet Tracer 7.3.*
    • Ubuntu 20.04 for Cisco Packet Tracer 8.0.0
  • Java 8 or higher.
  • xvfb and xvfb-run, if you want to run app using virtual display.

Usage

There are several possible ADEngine use cases:

  1. Use ADEngine from Python code. Actual documentation for API can be found here

  2. Run ADEngine server using command python3 -m adegine.server
    Additional parameters can be found using command python3 -m adengine.server --help
    Parameters can be passed to ADEngine using command line parameters or via environment variable.
    Command line parameters have and advantage.

    ParameterDescriptionUsing cmdUsing envPossible valuesDefault
    Log levelLevel of logs-ADENGINE_LOG_LEVELDEBUG,INFO,WARNING,ERRORINFO
    Queue sizeSize of queue with tasks--queue-sizeADENGINE_QUEUE_SIZEpositive integer20
    Read file timeoutTimeout for ADE to read file in seconds--read-file-timeoutADENGINE_READ_FILE_TIMEOUTpositive integer in range 5..6010
    Use virtual displayEnable using xvfb to run Packet Tracer--use-virtual-displayADENGINE_USE_VIRTUAL_DISPLAY0 or 1 for env, specified or not specified for cmdDisabled
    Result TTLResult time to live--result-ttlADENGINE_RESULT_TTLhh:mm:ss00:05:00
    Tasks before session restartNum of tasks before session restart--tasks-before-session-restartADENGINE_TASKS_BEFORE_SESSION_RESTARTpositive integer100
    Unix socketPath to unix socket--unix-socketADENGINE_UNIX_SOCKabsolute path to unix socket (non existent)/tmp/adengine.sock
    Max connectionsNum of maximum connections to server--max-connectionsADENGINE_MAX_CONNECTIONSpositive integer10

  3. Run ADEngine client using command python3 -m adegine.client
    Additional parameters can be found using command python3 -m adengine.client --help
    Parameters can be passed to ADEngine using command line parameters or via environment variable.
    Command line parameters have and advantage.

    ParameterDescriptionUsing cmdUsing envPossible valuesDefault
    ActivityAbsolute path to activity fileactivity-absolute path to file-
    PasswordPassword to activity file--password-stringNone
    Net stabilization delaySimulated network stabilization delay--net-stabilization-delay-non negative integer in range 0..6000
    SocketAbsolute path to unix socket to connect to ADEngine server--socketADENGINE_UNIX_SOCKabsolute path to file/tmp/adengine.sock

ru-RU:

О репозитории

Данный репозиторий содержит движок и API на Python для Activity Data Extractor.
Это специальный модуль Python, разработанный для параллельного извлечения данных из нескольких файлов Packet Tracer Activity.

Установка

  1. Скачайте и установите Cisco Packet Tracer
  2. Скачайте и установите Activity Data Extractor
  3. Скачайте и установите Python
  4. Установите движок из PyPI используя команду python3 -m pip install adengine
  5. Теперь движок должен быть установлен и готов к использованию

Требования к системе

  • Cisco Packet Tracer 7.3.0, 7.3.1 или 8.0.0.
    Вполне возможно, что движок будет работать и на более свежих версиях Cisco Packet Tracer, но эта функциональность не протестирована.
  • Activity Data Extractor 1.0.3 или выше.
  • Python 3.8 или выше.
  • ОС зависит от версии Packet Tracer
    • Ubuntu 18.04 для Cisco Packet Tracer 7.3.*
    • Ubuntu 20.04 для Cisco Packet Tracer 8.0.0
  • Java 8 или выше.
  • xvfb и xvfb-run, если вы хотите запустить приложение с использованием виртуального дисплея.

Usage

Есть несколько вариантов использования ADEngine:

  1. ADEngine можно использовать как модуль Python. Актуальная документация API находится здесь

  2. Запускать сервер ADEngine используя команду python3 -m adegine.server
    Дополнительный параметры можно посмотреть используя команду python3 -m adengine.server --help
    Параметры могут быть переданы серверу ADEngine используя аргументы командной строки или через переменные среды.
    Аргументы командной строки имеют преимущество.

    ПараметрОписаниеАргумент комадной строкиПеременная окруженияВозможные значенияЗначение по умолчанию
    Log levelУровень логирования-ADENGINE_LOG_LEVELDEBUG,INFO,WARNING,ERRORINFO
    Queue sizeРазмер очереди задач--queue-sizeADENGINE_QUEUE_SIZEположительное целое число20
    Read file timeoutТаймаут для ADE на чтение файла в секундах--read-file-timeoutADENGINE_READ_FILE_TIMEOUTположительное целое число в диапазоне 5..6010
    Use virtual displayВключает использование виртуального дисплея для запуска Packet Tracer--use-virtual-displayADENGINE_USE_VIRTUAL_DISPLAY0 или 1 для переменной окружения, указано или не указано для аргумента командной строкиВыключено
    Result TTLВремя жизни результата--result-ttlADENGINE_RESULT_TTLчч:мм:сс00:05:00
    Tasks before session restartКоличество выполненных задач перед перезапуском сессии--tasks-before-session-restartADENGINE_TASKS_BEFORE_SESSION_RESTARTположительное целое число100
    Unix socketПуть к unix сокету--unix-socketADENGINE_UNIX_SOCKабсолютный путь к unix сокету (на данный момент файл не должен существовать)/tmp/adengine.sock
    Max connectionsМаксимальное количество одновременных подключений к серверу--max-connectionsADENGINE_MAX_CONNECTIONSположительное целое число10

  3. Запускать клиент ADEngine используя команду python3 -m adegine.client
    Дополнительный параметры можно посмотреть используя команду python3 -m adengine.client --help
    Параметры могут быть переданы клиенту ADEngine используя аргументы командной строки или через переменные среды.
    Аргументы командной строки имеют преимущество.

    ПараметрОписаниеАргумент комадной строкиПеременная окруженияВозможные значенияЗначение по умолчанию
    ActivityАбсолютный путь до файла Packet Tracer Activityactivity-абсолютный путь до файла-
    PasswordПароль к файлу Packet Tracer Activity--password-строкаNone
    Net stabilization delayВремя стабилизации симулируемой сети--net-stabilization-delay-неотрицательное целое число в диапазоне 0..6000
    SocketАбсолютный путь до Unix сокета для подключения с серверу ADEngine--socketADENGINE_UNIX_SOCKабсолютный путь до файла/tmp/adengine.sock

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 2

Native requirements
2 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
psutil
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
psutil (>=5.8.0)runtime
pytest
Environment
{
  "extras": "",
  "marker": "extra == 'test'",
  "requires_python": ">=3.8",
  "evaluation": "NOT_EVALUATED"
}
pytest ; extra == 'test'runtime

Distribution files

2 collected
adengine-0.3.1-py3-none-any.whl

bdist_wheel · 26.83 KB · Python py3

Source file
adengine-0.3.1.tar.gz

sdist · 25.31 KB · Python source

Source file

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:26 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:c738630ec6dc4d04aa3ca7ada4c88e8a7bd825b75a9966f28d8ed2c08c54829e

Other collected versions

View all collected versions →