Learning how to write my own NASM debugger in Python. I plan to only target an extremely specific architecture at first.

I am using a Docker container during development, so you will need Docker installed. Follow the instructions here:

sudo apt-get remove docker docker-engine docker.io
sudo apt-get update
sudo apt-get install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
sudo apt-get install docker-ce
sudo groupadd docker
sudo usermod -aG docker "$USER"

This project also uses docker-compose to manage the container, so install that as well as follows:

sudo curl -L "https://github.com/docker/compose/releases/download/1.24.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
sudo curl -L https://raw.githubusercontent.com/docker/compose/1.24.0/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose

Then it is probably simplest to restart. You should be able to verify the installations with the following:

docker --version
docker-compose --version

You must be running X Server in your desktop environment.

You should have $XAUTHORITY point to the XAuthority file for your user as well. (This file essentially grants the application permission to use X Server.) This was already set for me running a Gnome desktop so check if it is set already first.

Finally, you will need to set $XKB_ROOT to point to XKB on your file system. Mine was located at /usr/share/X11/xkb so I set it to exactly that path.

You can run the application with:

./build-base-docker-image.sh
docker-compose up

The base Docker image is just to get around an annoying issue rebuilding in PyCharm, but it should work as above. Once built the first time, hopefully you will not need to build it again since requirements.txt is still reinstalled when it changes.

Ta da! :-)

This project uses FBS for releases. To build a release, just run this inside the docker VM:

fbs freeze
fbs installer

This can be run in the Docker container or within a venv on the correct OS for the release.

I am working on the project in PyCharm Professional, so Docker and Docker-Compose is integrated with the IDE. I also work with these plugins:

• Bash plugin so it is easy to run "sh" files.
• NASM plugin for some syntax highlighting.
• Markdown plugin for this file!

For PyCharm to correctly identify PyQt5 types, you will need to install PyQt5-Stubs. For reasons I could not deduce on my computer, these stubs did not install correctly into my remote libraries, so the type hints were not pulled through.

You can "fix" this by installing PyQt5-stubs in a normal project, and then literally copying the remote library site package into External Libraries, Remote Libraries, .../site-packages/ . The type hints should show up now.

You will also need GCC version 7+ (older versions may work. You will need the -Og optimisation flag for the build script).