This guide assumes the developer is using Microsoft Windows as the development platform. There is no requirement for this and developers are encouraged to add platform-specific instructions to this file.
"$" is used to designate the Prompt throughout this guide for any commands which should be typed into a shell, even though a Windows Batch Shell prompts using the current working directory; for example:
C:\Source\EdProxy\>
Please follow the coding conventions in the source files; specifically, indentation is via 4 spaces and not via tabs.
The developers have used a variety of editors, including emacs, Notepad++, and Android Studio.
The entry point is edproxy.py:
$ python edproxy.py
- Python 2.7
- wxPython
- psutil
- watchdog
- Pillow
- SendKeys
- ijson
- Tornado
NB: To ensure all of the following instructions work, Python must be added to the PATH environment variable. By default, the following directories must be added:
$ PATH=%PATH%;C:\Python27;C:\Python27\Scripts
$ python -m pip install psutil watchdog Pillow Sendkeys tornado ijson
TODO
As well as the pre-requisites for running the source (see above), the following requirements must be met:
PyInstaller can be installed using PIP; Inno Setup must be installed manually.
$ python -m pip install pyinstaller
A helper batch-file is included to create the binary, which takes a while to run.
$ win32-pyinstall.bat
The output is placed in the 'dist' directory from where it can be run and tested.
The configuration file for the installer is "win-innosetup.iss" and is located in the root directory of the source tree. If the default options are selected when installing Inno Setup, double-clicking on this file starts Inno Setup.
Edit the version number (if necessary), then click the "Compile" icon or use the "Build -> Compile" menu option to generate the installer.
The installer is generated in the "Output" directory. It can be installed using the "Run" option in Inno Setup, or by running it directly.
TODO