Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 4 KB

DEVELOPMENT.md

File metadata and controls

97 lines (71 loc) · 4 KB
Raw

CoilSnake Development Guide

Environment

Because Python is notorious for being difficult to maintain a clean installation of, it is recommended to develop either in a Python virtualenv or in an actual virtual machine.

Using a virtualenv

  1. sudo pip3 install virtualenv
  2. virtualenv CoilSnake_virtualenv --no-site-packages
  3. source CoilSnake_virtualenv/bin/activate
    • The above command sets up your CoilSnake virtual development environment. When you open a new terminal for CoilSnake development, always re-run the above command in order to re-enter the virtual development environment. For more information about how this works, see virtualenv's documentation.
  4. Follow the steps mentioned below for your respective system.

Using a virtual machine

For Windows, you'll probably want to follow the steps from a fresh virtual machine. You can start up a new Windows 10 VM by the following command: vagrant up windows

To make a Ubuntu VM, you can follow these instructions:

vagrant up ubuntu
vagrant ssh ubuntu
cd /vagrant

Please note that the included Vagrant configuration for Ubuntu does not run a GUI, meaning that you won't be able to test CoilSnake's GUI with it.

After installing a VM, follow the steps mentioned below for your respective system (Linux/Windows).

Linux

  1. Install any system dependencies required by CoilSnake. For Debian-based OSes, simply run:
sudo apt-get install python3-pip python3-dev g++ libyaml-dev \
                     python3-tk python3-pil.imagetk \
                     libjpeg-dev zlib1g-dev tk8.6-dev tcl8.6-dev
  1. Follow the 'Generic' instructions below.

macOS

  1. Install:
    1. Command Line Tools for Xcode
    2. Python 3.9
      • Do not install non-official builds - this one includes Tk 8.6, with fixes and a nicer-looking UI over Tk 8.5.
    3. Homebrew:
      • /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    4. libyaml:
      • brew install libyaml
    5. PyYAML with libyaml support:
      • python3 -m pip install pyyaml
  2. Follow the 'Generic' instructions below.

Windows

  1. Install:
    1. Python 3.9 (64-bit version)
    2. Visual C++ 2019 Build Tools
      • Select "C++ build tools" under the "Workloads" tab and make sure these are ticked:
        1. MSVC v140 - VS 2015 C++ x64/x86 build tools
        2. Windows 10 SDK
  2. Find a path that exists on your computer similar to C:\Program Files (x86)\Windows Kits\10\bin\10.0.19041.0\x86 and add it to your system environment variables.
  3. Follow the 'Generic' instructions below.
  4. In commands beginning with python3 use just python instead.

Generic

  1. Using your favorite git client, clone the CoilSnake repository.
  2. Open the command line and cd to your local CoilSnake git repository's main directory.
  3. python3 -m pip install pip==18.1
  4. Install dependencies:
    • python3 setup.py develop
  5. Build additional coilsnake dependencies:
    • python3 setup.py build

CoilSnake is now installed in development mode. After making code changes to the source, run your code by launching CoilSnake's GUI or CLI:

python3 script/gui.py
# or...
python3 script/cli.py

Creating a standalone executable

Note: The steps for creating a standalone executable are currently unmaintained and likely broken for systems other than 64-bit Windows.

  1. Follow the steps above to build CoilSnake for your system.
  2. Install pyinstaller:
    • python3 -m pip install pyinstaller
  3. In the CoilSnake source directory, build the CoilSnake executable:
    • python3 setup_exe.py
  4. Run the output file under the 'dist' directory.