PythonToolsKit 1.2.6

This package implements tools to build python package and tools.

PythonToolsKit

Description

This package implements useful tools and functions for producing python packages or tools implemented in python.

Features implemented:

• Timeout:
  • Timeout decorator using MultiThreading
  • Timeout decorator using MultiProcessing
  • Timeout decorator using signal (UNIX only)
• Terminal: ANSI features for terminal (color, position of the cursor, style...)
• StringF:
  • Format the strings length
  • Make a table from Sequence of strings
  • Make a table of Attribute/Value from python object
• PrintF:
  • Print states of tasks/programs
  • Print info, check OK/NOK, error... with prefix and color management
• Process: generator to read process output lines in real time
• Logs
  • Default logger builder
  • Decorator trace function (log the beginning and end of function execution)
  • Colored logger (StreamHandler only)
  • CSV formatter (logs in CSV format)
  • Handler for compressed log file rotation and store indefinitely
• GetPass: a getpass function showing "*"
• Encodings:
  • Generator to obtain probable encodings
  • Function to try to decode the data with probable encodings
  • Fast Base64 functions (without types/regex checks)
• DictObject:
  • Dynamic object (build from dict)
  • JsonDeserializer
  • CsvDeserializer
• Report:
  • Report as text/markdown
  • Report as CSV
  • Report as JSON
  • Report as HTML
  • Statistics
  • Sort and filter elements in the reports
  • The frequency and percentage of filtered elements
• urlopen:
  • New urlopen based on urllib.request with a easiest way to manage HTTP error code (using decorator)
• Dict:
  • Clean dict (for example, after loading the API response, you want to keep only certain informations)
  • Operator (some basic functions callable from operator)
• List:
  • Operator (some basic functions callable from operator)
• Tuple:
  • Operator (some basic functions callable from operator)
• Function:
  • Operator (some basic functions callable from operator)
• Arguments:
  • Password and password prompt
  • Input file and stdin
  • Output file and stdout
  • Verbose mode
  • Debug mode
• Thread:
  • Join all
  • Class SimpleThread
  • Thread decorator
• Import:
  • import from path/filename
• GetFile:
  • Research an existant file from current directory and lib directory
  • Open an existant file from current directory or lib directory
• ScapyTools:
  • Command line arguments for scapy (ArgumentParser with an optional argument "interface" by default and iface research)
• GetType
  • Type string value (None, bool, int, float, IP)
  • Numbers (int, float) and IP/network generator from string
• Random: Get random strings (random length, generator, check for strong password, secure, urlsafe, ...)
• Json:
  • Load invalid JSON
  • Correct invalid JSON
• WindowsTerminal:
  • Activate/desactivate temporary/persistent virtual terminal (colors, font, ...) on Windows
  • Set temporary/persistent terminal transparency on Windows
• Colors:
  • Build 8bits-color byte
  • Get 3 bytes color from HTML/CSS colors (#HEX, rgb function and rgba function)
  • Check and safe methods are available for all these features
• DataAnalysis:
  • Data statistics
    • frequences (pourcent)
      • Keys
      • Values
      • Keys and values
      • Keys and values counters
    • averages
    • variances
    • deviations
    • medians
    • sum
    • max
    • min
  • Data filtering
  • Counter/getter
    • Count/get values greater than
    • Count/get values lesser than
    • Count value equal to
    • Count different values by key
  • Sort
    • Values
    • Keys
    • Values counters
    • Values sum
  • Generate chart (using matplotlib)
    • statistictypes
    • valuetypes (values)
    • valuetypes (counters)
  • Print data tables
    • statistictypes
    • dictionnaries
    • valuetypes
  • Group data by values
• RecursionDebug: Help you to debug RecursionError
• OrdDict: A fast and powerful Ordered Dict
• Characters: Returns integers, string (latin-1), binary and hexadecimal from integers, string (latin-1), binary or hexadecimal
• DebugEncoding: Found used encoding when you have encoding problems

Requirements

This package require:

• python3
• python3 Standard Library

To use PythonToolsKit.ScapyTools you need Scapy, but is not installed by default (because this is the only module that needs it), install it with python3 -m pip install scapy

To use PythonToolsKit.DataAnalysis.show_chart you need matplotlib, but is not installed by default (because this is the only function that needs it), install it with python3 -m pip install matplotlib

Installation

pip install PythonToolsKit

Usages

Examples with responses (mode console) are available in HTML documentation.

Note for import: add PythonToolsKit.<module>

from PythonToolsKit.Timeout import *
import PythonToolsKit.Timeout

Tools

Characters

python3 Characters.pyz mystring
python3 -m PythonToolsKit.Characters integers 97,98,99

Characters string abc
Characters hexa 616263
Characters hexa '61-62-63'
Characters hexa '61 62 63'
Characters hexa '61:62:63'
Characters binary '1100001 1100010 1100011'

python3 DebugEncoding.pyz éêâ --bad-values "‚ˆƒ"
python3 -m PythonToolsKit.DebugEncoding éêâ --decoding cp1252 --bad-values "‚ˆƒ" --json

DebugEncoding éêâ
DebugEncoding éêâ --encoding cp437

Unittests

For GetType and Json, Encodings, Colors and WindowsTerminal modules i use doctest (unittests in documentation) and coverage:

python3 GetType.py             # run doctest with verbose mode
python3 -m doctest GetType.py  # run doctest without verbose mode
coverage run GetType.py        # Calcul coverage
coverage report                # Report in console
coverage html                  # Report in HTML page

Module	Coverage	Statements	missing
GetType.py	100%	130	000
Json.py	100%	046	000
Encodings.py	100%	054	000
WindowsTerminal.py	094%	096	006
Colors.py	100%	176	000
DataAnalysis.py	100%	290	000
Report.py	099%	160	001
StringF.py	100%	067	000
OrdDict.py	100%	172	000
Characters.py	078%	063	014

Links

• Github Page
• Documentation Timeout
• Documentation Terminal
• Documentation StringF
• Documentation PrintF
• Documentation Process
• Documentation Logs
• Documentation GetPass
• Documentation Encodings
• Documentation DictObject
• Documentation Report
• Documentation urlopen
• Documentation Dict
• Documentation Arguments
• Documentation Tuple
• Documentation List
• Documentation Function
• Documentation Thread
• Documentation Import
• Documentation ScapyTools
• Documentation GetFile
• Documentation GetType
• Documentation Random
• Documentation Json
• Documentation WindowsTerminal
• Documentation Colors
• Documentation DataAnalysis
• Documentation RecursionDebug
• Documentation OrdDict
• Documentation Characters
• Executable Characters
• Documentation DebugEncoding
• Executable DebugEncoding
• Pypi package

Licence

Licensed under the GPL, version 3.