Devkit for quickly building CLI tools with Python
Make a CLI tool with very few lines of code.
This library is aimed to provide useful features and helpers in order to shorten the number of required lines of code for writing simple and nice-looking command-line interface tools. It is based on
argparse and is considered a development kit, on the contrary of popular frameworks like
docopt, as it is not aimed to reinvent the wheel in yet another paradigm.
pip install tinyscript
This library is built with the DRY (Don't Repeat Yourself) and KISS (Keep It Stupid Simple) philosophies in mind ; the whole machinery of Tinyscript holds in its star import (
from tinyscript import *) and its initialization (with the
It is aimed to shorten required code by setting a few things while loaded:
- a proxy parser (coming from the star import) collects arguments definitions and formats help at initialization, preventing from rewriting the whole bunch of code needed to declare an
ArgumentParser(and define its epilog, and so forth)
- a main (colored) logger is preconfigured and can be tuned through two constants so that we don't care for writing a bunch of code needed to configure logging
- preimports (while a bit anti-Pythonic, we confess) of common libraries also reduces the quantity of code required
- among these, some modules are enhanced with new functions and classes that are not natively foreseen
Leveraging this allows to create very short scripts with only the real code that matters, reducing the code to be rewritten to create efficient, nice-looking and sophisticated CLI tools.
Note that, while star imports should be avoided according to Python's style guide (see PEP8), it is deliberately extensively used and covering a huge scope in order to shorten code length. This "anti-pattern" pays off after creating a few tools, when we can realize it shortens parts of the code that are often repeated from a tool to another (e.g. for shaping tool's help message).
It is designed to be as simple and straightforward to use as possible. In order to learn and use it, you only need your browser (for consulting the documentation), a text editor and a good Python Interpreter (e.g. IDLE) for using auto-completion or an IDE like PyCharm to get helpers suggested.
The point is that you will use:
- features, enabled by setting flags in the "master" function called
- helpers, grouped under the "master" submodule called
- reporting objects from the global scope
Please see the example tools herebelow for examples of usage of features, helpers and reporting.
:fast_forward: Quick Start
Create from template
Run your tool
:mag: Example tools
- AppMemDumper (Windows forensics)
- Bots Scheduler (Web security services job scheduler)
- DroneSploit (startup script)
- Evil Pickle Creation Tool (Python evil pickle generation tool)
- Malicious Macro Tester (malicious VB macro detection)
- Paddinganograph (base32/64 padding-based steganography)
- PDF Passwords Bruteforcer (bruteforce tool)
- Solitaire Cipher (encryption)
- StegoLSB (Least Significant Bit)
- StegoPIT (Pixel Indicator Technique)
- StegoPVD (Pixel Value Differencing)
- STIX Report Generator
- WLF (Word List Filter)
- Audio Assembler
- Documentation Text Masker
- Email Origin
- Loose Comparison Input Generator (PHP Type Juggling)
- PDF Preview Generator
- Recursive Compression
- WebGrep (Web text search)
- Zotero CLI
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.