mangle/INSTALL.md

53 lines
1.3 KiB
Markdown
Raw Normal View History

2021-03-28 02:52:02 +00:00
# Install Instructions
2021-03-30 00:55:25 +00:00
For local development / building stand-alone binaries.
2021-03-28 02:52:02 +00:00
2021-03-30 00:55:25 +00:00
You need [Python 2.7](https://www.python.org/downloads/release/python-2718/).
2021-03-30 00:14:53 +00:00
2021-03-30 00:55:25 +00:00
If you are using Windows download the
`Windows x86 MSI installer`
because 32 bit Python is needed to create
a Windows executable with `py2exe`.
The performance increase from 64 bit is negligible.
2021-03-30 00:14:53 +00:00
Be sure to add `python` to `PATH` during installation.
2021-03-28 02:52:02 +00:00
2021-03-28 16:28:05 +00:00
Install [virtualenv](https://virtualenv.pypa.io/en/stable/)
globally, if you don't already have it.
2021-03-28 02:52:02 +00:00
```
> pip install virtualenv
```
and install all dependencies in a venv in the mangle directory, e.g.
```
...\mangle> virtualenv venv
> venv\Scripts\activate
2021-03-30 00:13:07 +00:00
(venv) > pip install -r requirements.txt
2021-03-28 02:52:02 +00:00
```
2021-03-30 00:55:25 +00:00
You can run the app via
2021-03-28 02:52:02 +00:00
```
(venv) > python mangle.pyw
```
Optionally, you can install all the dependencies globally
so you can simply click on the `mangle.pyw` file to run it.
2021-03-30 00:55:25 +00:00
# Building an Executable (Windows)
2021-03-28 02:52:02 +00:00
To actually build a stand-alone `.exe`, install
2021-03-28 16:28:05 +00:00
2021-03-28 02:52:02 +00:00
[Microsoft Visual C++ Compiler for Python 2.7](https://www.microsoft.com/en-us/download/details.aspx?id=44266)
A standalone binary can be created in the `dist` folder via
```
(venv) > python setup.py install
```
You may get an error which can be solved by looking at
https://stackoverflow.com/questions/38444230/error-converting-gui-to-standalone-executable-using-py2exe