Clear your terminal in a ritual way. Zero dependency.
Project description
Wipe Clean
Clear your terminal in a fun way. Works on Windows, Linux and macOS. 0-dependency.
Install • Usages • Advanced usages • Roadmap • Related projects
Install
Install with pip:
pip install wipe-clean
wipe-clean
currently requires Python 3.6.1 and above. Note that Python 3.6.0 is not supported due to lack ofNamedTuples
typing.
Usages
Just:
wipe-clean
Use -h, --help
to show all available options
wipe-clean -h
Advanced usages
1. Use API
You can use wipe-clean inside your project.
from wipe_clean.main import cli as wc_cli
wc_cli()
# Or with arguments
wc_cli('--frame-interval=0.005', '--min-frame-delay=0')
2. Customization
It's possible to design your own brush shape and animation.
Example brush
To create a new brush type, implement the Brush
interface, e.g.
from wipe_clean.brush import Brush, ScreenPointDrawing, ScreenPoint as P
class Wipe2x2(Brush):
def get_points(self, x, y, angle) -> List[ScreenPointDrawing]:
return [
ScreenPointDrawing(P(x , y ), '#'), # noqa: E202,E203
ScreenPointDrawing(P(x + 1, y ), '#'), # noqa: E202,E203
ScreenPointDrawing(P(x , y + 1), '#'), # noqa: E202,E203
ScreenPointDrawing(P(x + 1, y + 1), '#'),
]
This will define a brush like this:
##
##
Example path
Similarly, you can implement the Path
interface to create a new brush path.
import math
from wipe_clean.path import Path, PathPoint, ScreenPoint as P
class MySimplePath(Path):
def get_points(self) -> Iterable[PathPoint]:
return [
PathPoint(P(10, 10), math.radians(45)),
PathPoint(P(20, 5), math.radians(0)),
PathPoint(P(40, 20), math.radians(90)),
]
Roadmap
See DEVELOPMENT.md
Related projects
-
JeanJouliaCode/wipeclean
- JavaScript versionThe first brush type (
BrushWipe
) and path animations (PathZigZag
,PathRectEdge
) are direct ports ofJeanJouliaCode/wipeclean
. Credits go to JeanJouliaCode! -
Textualize/rich
- An inspiring textual UI library
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wipe_clean-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6eb31080da99b717aa63a035366ed6ed629270659a3107431f26f4f51edf5bd3 |
|
MD5 | 16b587bda0c042d468c66fd46bf4317f |
|
BLAKE2b-256 | 49e25275334c795b7e61080b42548a9bb80e2eda4254b2c1f5e965545a3659d4 |