Skip to content

Nix flake + python package #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
machshev wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Nix flake + python package #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b8a10a
build: add nix flake
machshev Sep 30, 2025
0484a96
create a proper python package rather than just scripts
machshev Sep 30, 2025
afbad9e
Ruff format
machshev Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .envrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
use flake
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,3 +708,6 @@ FodyWeavers.xsd
# End of https://www.toptal.com/developers/gitignore/api/visualstudio,c++,c,python,visualstudiocode,macos,windows
software/script/tests/nonces.bin
software/script/nonces.bin

# Direnv
.direnv
61 changes: 61 additions & 0 deletions flake.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

63 changes: 63 additions & 0 deletions flake.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
{
description = "Nix development environment";

inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
flake-utils.url = "github:numtide/flake-utils";
};

outputs = {
nixpkgs,
flake-utils,
...
}:
flake-utils.lib.eachDefaultSystem (system: let
pkgs = nixpkgs.legacyPackages.${system};
pythonPackages = pkgs.python3Packages;
in {
devShells = {
default = pkgs.mkShell {
name = "impurePythonEnv";
venvDir = "./.venv";

# Packages required to build the venv
buildInputs = [
# The interpreter to use
pythonPackages.python
# automatically create the venv
pythonPackages.venvShellHook
# get nix to install wxpython as whl doesn't work on NixOS
];

# Runtime packages
packages = [
# Python dev tools
pythonPackages.ipython
pythonPackages.ipdb
pkgs.uv
pkgs.ruff
pkgs.pyrefly
];
env = {
# Make breakpoint() use ipdb instead of the builtin pdb
PYTHONBREAKPOINT = "ipdb.set_trace";

};
postVenvCreation = ''
unset SOURCE_DATE_EPOCH
# Install chameleon as an editable package
pip install -e software
'';

# Now we can execute any commands within the virtual environment.
# This is optional and can be left out to run pip manually.
postShellHook = ''
# allow pip to install wheels
unset SOURCE_DATE_EPOCH
'';
};
};

formatter = nixpkgs.legacyPackages.${system}.alejandra;
});
}
Empty file added software/chameleon/__init__.py
View file
Open in desktop
Empty file.
88 changes: 53 additions & 35 deletions software/script/chameleon_cli_main.py → software/chameleon/cli.py
100755 → 100644
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
#!/usr/bin/env python3
import argparse
import sys
import traceback
import chameleon_com
import colorama
import chameleon_cli_unit
import chameleon_utils
import pathlib
import prompt_toolkit
from prompt_toolkit.formatted_text import ANSI
from prompt_toolkit.history import FileHistory
from chameleon_utils import CR, CG, CY, C0
from chameleon.utils import (
CR,
CG,
CY,
C0,
CLITree,
ArgsParserError,
ParserExitIntercept,
UnexpectedResponseError,
CustomNestedCompleter,
)
from chameleon.com import ChameleonCom
from chameleon.unit import root, BaseCLIUnit, check_tools

ULTRA = r"""
╦ ╦╦ ╔╦╗╦═╗╔═╗
Expand All @@ -37,15 +45,16 @@

class ChameleonCLI:
"""
CLI for chameleon
CLI for chameleon
"""

def __init__(self):
# new a device communication instance(only communication)
self.device_com = chameleon_com.ChameleonCom()
self.device_com = ChameleonCom()

def get_cmd_node(self, node: chameleon_utils.CLITree,
cmdline: list[str]) -> tuple[chameleon_utils.CLITree, list[str]]:
def get_cmd_node(
self, node: CLITree, cmdline: list[str]
) -> tuple[CLITree, list[str]]:
"""
Recursively traverse the command line tree to get to the matching node

Expand All @@ -68,8 +77,7 @@ def get_prompt(self):

:return: current cmd prompt
"""
device_string = f"{CG}USB" if self.device_com.isOpen(
) else f"{CR}Offline"
device_string = f"{CG}USB" if self.device_com.isOpen() else f"{CR}Offline"
status = f"[{device_string}{C0}] chameleon --> "
return status

Expand All @@ -83,34 +91,36 @@ def print_banner():
print(f"{CY}{BANNER}{C0}")

def exec_cmd(self, cmd_str):
if cmd_str == '':
if cmd_str == "":
return

# look for alternate exit
if cmd_str in ["quit", "q", "e"]:
cmd_str = 'exit'
cmd_str = "exit"

# look for alternate comments
if cmd_str[0] in ";#%":
cmd_str = 'rem ' + cmd_str[1:].lstrip()
cmd_str = "rem " + cmd_str[1:].lstrip()

# parse cmd
argv = cmd_str.split()

tree_node, arg_list = self.get_cmd_node(chameleon_cli_unit.root, argv)
tree_node, arg_list = self.get_cmd_node(root, argv)
if not tree_node.cls:
# Found tree node is a group without an implementation, print children
print("".ljust(18, "-") + "".ljust(10) + "".ljust(30, "-"))
for child in tree_node.children:
cmd_title = f"{CG}{child.name}{C0}"
if not child.cls:
help_line = (f" - {cmd_title}".ljust(37)) + f"{{ {child.help_text}... }}"
help_line = (
f" - {cmd_title}".ljust(37)
) + f"{{ {child.help_text}... }}"
else:
help_line = (f" - {cmd_title}".ljust(37)) + f"{child.help_text}"
print(help_line)
return

unit: chameleon_cli_unit.BaseCLIUnit = tree_node.cls()
unit: BaseCLIUnit = tree_node.cls()
unit.device_com = self.device_com
args_parse_result = unit.args_parser()

Expand All @@ -121,11 +131,11 @@ def exec_cmd(self, cmd_str):
args_parse_result = args.parse_args(arg_list)
if args.help_requested:
return
except chameleon_utils.ArgsParserError as e:
except ArgsParserError as e:
args.print_help()
print(f'{CY}'+str(e).strip()+f'{C0}', end="\n\n")
print(f"{CY}" + str(e).strip() + f"{C0}", end="\n\n")
return
except chameleon_utils.ParserExitIntercept:
except ParserExitIntercept:
# don't exit process.
return
try:
Expand All @@ -143,22 +153,25 @@ def exec_cmd(self, cmd_str):
if error is not None:
raise error

except (chameleon_utils.UnexpectedResponseError, chameleon_utils.ArgsParserError) as e:
except (
UnexpectedResponseError,
ArgsParserError,
) as e:
print(f"{CR}{str(e)}{C0}")
except Exception:
print(
f"CLI exception: {CR}{traceback.format_exc()}{C0}")
print(f"CLI exception: {CR}{traceback.format_exc()}{C0}")

def startCLI(self):
"""
start listen input.

:return:
"""
self.completer = chameleon_utils.CustomNestedCompleter.from_clitree(chameleon_cli_unit.root)
self.session = prompt_toolkit.PromptSession(completer=self.completer,
history=FileHistory(str(pathlib.Path.home() /
".chameleon_history")))
self.completer = CustomNestedCompleter.from_clitree(root)
self.session = prompt_toolkit.PromptSession(
completer=self.completer,
history=FileHistory(str(pathlib.Path.home() / ".chameleon_history")),
)

self.print_banner()
cmd_strs = []
Expand All @@ -168,21 +181,26 @@ def startCLI(self):
else:
# wait user input
try:
cmd_str = self.session.prompt(
ANSI(self.get_prompt())).strip()
cmd_strs = cmd_str.replace(
"\r\n", "\n").replace("\r", "\n").split("\n")
cmd_str = self.session.prompt(ANSI(self.get_prompt())).strip()
cmd_strs = (
cmd_str.replace("\r\n", "\n").replace("\r", "\n").split("\n")
)
cmd_str = cmd_strs.pop(0)
except EOFError:
cmd_str = 'exit'
cmd_str = "exit"
except KeyboardInterrupt:
cmd_str = 'exit'
cmd_str = "exit"
self.exec_cmd(cmd_str)


if __name__ == '__main__':
def main():
"""Cli main entry point."""
if sys.version_info < (3, 9):
raise Exception("This script requires at least Python 3.9")
colorama.init(autoreset=True)
chameleon_cli_unit.check_tools()
check_tools()
ChameleonCLI().startCLI()


if __name__ == "__main__":
main()
Loading
Loading