Skip to main content

A GUI Front end for creating TTP Templates

Project description

TTP Builder GUI Application

Introduction

TTP Builder is a Python-based GUI application built using PyQt6 that facilitates the creation and testing of Text-based Template Parsing (TTP) templates. TTP Builder accelerates the process of creating and testing TTP templates for network automation projects.

Features

  • Text Editor: A primary text editor to paste sample text data.
  • Named Selections: A ListWidget displays identified variables parsed from the sample text data.
  • Template Generator: A 'Generate Template' button for automated TTP template creation.
  • Help System: In-app help documentation linking directly to TTP's official documentation and an "About" section.

Screen Shots

builder.png
template.png
result.png

Pre-requisites

  • Python 3.x
  • PyQt6
  • PyQt6-WebEngine (For Help menu)
  • TTP

Install and Run

From an activated venv environment

pip install ttpbuilder

Execute: ttpbuilder

git clone https://github.com/scottpeterman/ttpbuilder.git
cd ttp_builder

Install the required packages.

pip install -r requirements.txt

Run the application.

python main.py

How to Use

  1. Paste Sample Data: Open the app and paste your sample text data into the text editor on the left-hand side.
  2. Named Selections: After pasting text data, highlight a section of the text that you want to be a variable in the TTP template. Right-click and choose "Create Named Selection".
  3. ListWidget: This will populate the ListWidget on the right with your identified variables. You can edit or remove these as necessary.
  4. Generate Template: Once you've highlighted all variables of interest, click on the 'Generate Template' button at the bottom to create the TTP template.
  5. Help Menu: Use the Help menu for additional resources and documentation on TTP.

Technologies and Libraries Used

  • PyQt6: For the GUI.
  • QWebEngineView: For embedded web browser support.
  • TTP: For template generation logic.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ttpbuilder-0.2.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ttpbuilder-0.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file ttpbuilder-0.2.tar.gz.

File metadata

  • Download URL: ttpbuilder-0.2.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for ttpbuilder-0.2.tar.gz
Algorithm Hash digest
SHA256 10d333f2f32c47560d6b6a2188a05215e06991ec5c0b60427c3e279582931fb3
MD5 44a5ec2fa2e3813f1e04bd74eb1f5fed
BLAKE2b-256 3fea09f495e1cbd2d5b7ef2226205a8ba1901dd424e6583c1743615d93d0f465

See more details on using hashes here.

File details

Details for the file ttpbuilder-0.2-py3-none-any.whl.

File metadata

  • Download URL: ttpbuilder-0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for ttpbuilder-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0ff16265ecec6e0273544c4cd9fd210bdeadfc4c2ca9ecbd3bc1f72050b6ee76
MD5 deb870b4a9c90f9f5185a3bade2844ae
BLAKE2b-256 65aaac902c26517dcbe320657834e9996842bce459ceb74efa8b283d0294e0da

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page