ECHOOF Development README

Windows dependencies

First, run CMD as administrator

winget install -e --id=Python.Python.3.12
winget install -e --id=WiXToolset.WiXCLI

Second, run cmd as regular user

pip install setuptools pyinstaller Cython

Running ECHOOF from sources

python -m echoof.cli

Running unit tests

ECHOOF comes with some basic unit tests for validating functionality.

Run all tests

python -m unittest discover -s tests

Generating configuration files for version release, i.e. 0.1.0

python generate_configuration.py 0.1.0

Building for Linux

python -m build

Uploading to PyPI

python3 -m twine upload --repository pypi dist/*

Building for Windows

Run executable build script

Run build_exe.cmd, this will build the executable using pyinstaller. There is a small wrapper script echoof_launcher.py used to launch the cli code. Installer will also be built. This also generates the appropriate winget manifests in the winget path.

Uploading to Winget

• Create release on Github using version number as tag.
• Include MSI in release.
• Copy the version folder i.e 0.1.0 from inside the winget path to https://github.com/ezoa-page/fork-winget-pkgs/tree/master/manifests/e/Ezoa/ECHOOF/, then do a pull request.