textcanvas 3.8.0

Draw to the terminal like an HTML Canvas.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

ERROR := \x1b[0;91m
INFO := \x1b[0;94m
NC := \x1b[0m

define show_help_message
	echo "Usage: make TARGET"
	echo ""
	echo "Commands:"
	grep -hE '^[A-Za-z0-9_ \-]*?:.*##.*$$' $(MAKEFILE_LIST) | \
	    awk 'BEGIN {FS = ":.*?## "}; {printf "  $(INFO)%-20s$(NC) %s\n", $$1, $$2}'
endef

define show_error_message
	echo "$(ERROR)[Error] $(1)$(NC)"
endef

SOURCE_DIRS := textcanvas tests

.PHONY: all
all: help

.PHONY: help
help: ## Show this help message
	@$(show_help_message)

.PHONY: clean
clean: ## Remove temporary files and data
	@rm -rf ./dist/
	@rm -rf ./var/htmlcov
	@rm -rf ./.coverage
	@rm -rf ./.ruff_cache/
	@rm -rf ./__pycache__/
	@rm -rf ./*.egg-info/
	@find $(SOURCE_DIRS) -name "__pycache__" -prune -exec rm -rf {} \;
	@find $(SOURCE_DIRS) -name "*.py[co]" -prune -exec rm -rf {} \;
	@find $(SOURCE_DIRS) -name "*.so" -prune -exec rm -rf {} \;
	@cargo clean

.PHONY: check
check: ## Most stringent checks (includes checks still in development)
	@rustup update || :
	@cargo fmt
	@cargo doc --no-deps --all-features
	@cargo check
	@cargo clippy --all-targets --all-features -- -D warnings -W clippy::all -W clippy::cargo -W clippy::complexity -W clippy::correctness -W clippy::nursery -W clippy::pedantic -W clippy::perf -W clippy::style -W clippy::suspicious -A clippy::missing_const_for_fn -A clippy::option_if_let_else -A clippy::suboptimal_flops -A clippy::while_float
	@make rust-test
	@make rust-coverage-pct
	@make python-test
	@make python-coverage-pct

.PHONY: rt
rt: rust-test
.PHONY: rust-test
rust-test: ## Run Rust unit tests
	@cargo test

.PHONY: lrt
lrt: light-rust-test
.PHONY: light-rust-test
light-rust-test: ## Run light Rust unit tests
	@cargo test --quiet --tests

.PHONY: pt
pt: python-test
.PHONY: python-test
python-test: ## Run Python unit tests
	@uv run python -m unittest

.PHONY: doc
doc: ## Build documentation
	@cargo doc --all-features
	@echo file://$(shell pwd)/target/doc/$(shell basename $(shell pwd))/index.html

.PHONY: rc
rc: rust-coverage
.PHONY: rust-coverage
rust-coverage: ## Rust unit tests coverage report
	@cargo tarpaulin --engine Llvm --timeout 120 --out Html --output-dir target/ --all-features
	@echo file://$(shell pwd)/target/tarpaulin-report.html

.PHONY: rust-coverage-pct
rust-coverage-pct: ## Ensure code coverage of 100%
	@coverage=$$(cargo tarpaulin --engine Llvm --out Stdout 2>&1); \
		percent_covered=$$(echo "$$coverage" | grep -o '^[0-9]\+\.[0-9]\+% coverage' | cut -d'%' -f1); \
		echo $$percent_covered; \
		[ $$(echo "$$percent_covered == 100" | bc -l) -eq 0 ] && exit 1; \
		exit 0

.PHONY: pc
pc: python-coverage
.PHONY: python-coverage
python-coverage: ## Python unit tests coverage report
	@rm -rf var/htmlcov
	@uv run coverage run -m unittest
	@uv run coverage html -d var/htmlcov
	@#uv run coverage report
	@echo file://$(shell pwd)/var/htmlcov/index.html

.PHONY: python-coverage-pct
python-coverage-pct: ## Ensure code coverage of 100%
	@uv run coverage run -m unittest > /dev/null 2>&1 || :
	@uv run coverage json -q -o /dev/stdout | uv run python -c \
		'import decimal, json, sys; \
		coverage = json.loads(input(), parse_float=decimal.Decimal); \
		percent_covered = coverage["totals"]["percent_covered"]; \
		print(percent_covered); \
		sys.exit(0 if percent_covered == 100 else 1);'

# .PHONY: pp
# pp: python-profile
# .PHONY: python-profile
# python-profile: ## Profile file or module
# 	@uv run python -m cProfile -s tottime -m tests/profiling.py

.PHONY: l
l: lint
.PHONY: lint
lint: ## Run various linting tools
	@ __CARGO_FIX_YOLO=1 pre-commit run --all-files

%:
	@$(call show_error_message,Unknown command '$@')
	@$(show_help_message)