kiwi-scan 0.2.0__tar.gz

kiwi_scan-0.2.0/.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.kiwi_sync/
+
+# PyInstaller
+*.manifest
+*.spec
+*.patch
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.pytest_cache/
+pytestdebug.log
+LOG
+LOG.*
+
+# Type checker
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+
+# PyCharm
+.idea/
+
+# VS Code
+.vscode/
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# Jupyter
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Logs
+*.log
+
+# Local runtime data
+*.sqlite3
+*.db
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Build documentation
+docs/_build/
+
+# tags
+cscope.files
+cscope.out
+tags
+
+# Temporary files
+*.tmp
+*.swp
+*.swo
+*~
+
+# Python packaging metadata
+*.dist-info/
+
+# Ruff / Black / other tooling caches
+.ruff_cache/
+.black/
+
+# Project-specific: scan output files (timestamped names like base-YYYYMMDDHHMMSS.txt)
+# Matches e.g. "results-20260315123045.txt" or "scan-20260315123045.txt"
+*-??????????????.*
+
+# Optional: exclude scan data directory if you create one
+scandata/
+data/
+
+*.orig
+*.1st

kiwi_scan-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Helmholtz-Zentrum Berlin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kiwi_scan-0.2.0/Makefile

@@ -0,0 +1,70 @@
+SHELL := /bin/bash
+VERSION ?= 0.2.0
+.DEFAULT_GOAL := help
+
+BASH_COMPLETION_DIR ?= ~/.bash_completion.d
+WITH_VENV = if [ -z "$$VIRTUAL_ENV" ]; then source "$(CURDIR)/mkvenv.sh"; fi
+
+SCRIPTS = \
+    scan_runner \
+    actuator_runner \
+    scanplotter_cli \
+    manifestfiles
+
+SCRIPT_PATHS = $(foreach script,$(SCRIPTS),$(BASH_COMPLETION_DIR)/$(script))
+
+.PHONY: help all install_completion uninstall_completion clean cscope tag lint test
+
+help: ## Show available development targets
+	@echo "kiwi-scan development targets"
+	@echo
+	@awk 'BEGIN {FS = ":.*## "} /^[a-zA-Z0-9_.-]+:.*## / { printf "  %-22s %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+all: install_completion ## Install bash completion scripts
+
+install_completion: ## Install bash completion files and add source lines to ~/.bashrc
+	@mkdir -p $(BASH_COMPLETION_DIR)
+	@for script in $(SCRIPTS); do \
+		cp bash-completion/$$script $(BASH_COMPLETION_DIR)/$$script; \
+		grep -q "$$script" ~/.bashrc || echo "source $(BASH_COMPLETION_DIR)/$$script" >> ~/.bashrc; \
+	done
+	@echo "Bash completion for $(SCRIPTS) installed. Reload your shell to activate."
+
+uninstall_completion: ## Remove installed bash completion files
+	@for script in $(SCRIPTS); do \
+		rm -f $(BASH_COMPLETION_DIR)/$$script; \
+	done
+	@echo "Bash completion for $(SCRIPTS) removed. Edit your .bashrc and remove the source lines."
+
+clean: ## Remove local virtualenv, caches, tags, and egg-info
+	@rm -rf .venv
+	@rm -f tags cscope.files cscope.out
+	@find src -maxdepth 1 -type d -name "*.egg-info" -exec rm -rf {} +
+	@find . -type d -name "__pycache__" -exec rm -r {} +
+
+cscope: ## Build cscope and ctags indexes for the repository
+	find . -path ./.venv -prune -o -name "*.py" -print > cscope.files
+	cscope -b -i cscope.files
+	ctags -R --languages=Python .
+
+tag: ## Create a version+timestamp git tag from HEAD
+	@ts=$$(git show -s --format=%cd --date=format:%Y%m%d.%H%M%S HEAD); \
+	tag="$(VERSION)+$$ts"; \
+	echo "Creating tag $$tag"; \
+	git tag -a $$tag -m "Release $$tag"
+
+lint: ## Run pylint on src/kiwi_scan (uses mkvenv.sh when needed)
+	@echo 'For pylint install extra packages: pip install -e ".[dev]"'
+	@$(WITH_VENV); \
+	PYTHONPATH=src pylint --disable=C,R,W src/kiwi_scan || true
+
+test: ## Run the current test scripts (uses mkvenv.sh when needed)
+	@if [ -z "$$KIWI_SCAN_DATA_DIR" ]; then mkdir -p scandata; fi
+	@$(WITH_VENV); \
+	python3 tests/test_actuator.py; \
+	EPICS_WRITETEST=1 python3 tests/test_epics_wrapper_integration.py; \
+	python3 tests/test_stats.py; \
+	python3 tests/test_registry_trigger_and_callbacks.py; \
+	python3 tests/test_subscription_manager.py; \
+	python3 tests/test_scanlib.py; \
+	python3 tests/test_manifest_writer.py