1. marlowe_ui Avatar marlowe_ui
  2. marlowe_ui
  3. marlowe_ui

Wiki

Clone wiki

marlowe_ui / developers

View History

For Developers

Author: Takaaki AOKI <aoki.takaaki@nagoya-u.jp>
Version: 0.5.7
Date: 2020-11-04

Preperation of development environment

Python and venv

Python 3.7 (or above) is recommended. To create and work with virtualenv directory.

> python -m venv mui_dev
> cd mui_dev
> Scripts/activate.bat
(mui_dev) > (work on venv)
> deactivate.bat

packages

The following packages are required

written in setup.py

marlowe_ui package requires lockfile(https://pypi.org/project/lockfile/) and lark-parser (https://pypi.org/project/lark-parser/). These packages might be explicitly installed by setup.py

(mui_dev) > pip install lockfile
(mui_dev) > pip install lark-parser

to deploy to PyPI

twine (https://pypi.org/project/twine/) is used to deploy marlowe_ui to PyPI.

(mui_dev) > pip install twine

to build windows package

cx-Freeze (https://pypi.org/project/cx-Freeze/) and pywin32 (https://pypi.org/project/pywin32/) should be installed to build .exe package for windows

(mui_dev) > pip install cx_Freeze
(mui_dev) > pip install pywin32

to build documents

docutils (which provides rst2html.py command) and pygments packages are required to build .html documents. However, these are not necessary to be installed in the venv explicitly.

(mui_dev) > pip install docutils
(mui_dev) > pip install pygments

Inno setup

Inno setup (http://jrsoftware.org/isinfo.php) is required to build windows installer. Usually setup program is installed in 'C:\Program Files (x86)Inno Setup 5' . If not, give a correct path in make_win_package.bat

Build

(mui_dev) > make_win_package.bat

creates

  • Windows installer package as dist\\marlowe_ui-(version)-win-amb64.exe
  • Html pages under html

deployment

upload to PyPI

deploy.bat is utility to upload the current version of package to PyPI.

deploy.bat

upload Windows Binary

upload dist\\marlowe_ui-(version)-win-amd64.exe to https://bitbucket.org/marlowe_ui/marlowe_ui/downloads

update project document

Project documents are in https://bitbucket.org/marlowe_ui/marlowe_ui/wiki

and available by:

git clone https://bitbucket.org/marlowe_ui/marlowe_ui/wiki

The contents are almost same as marlowe_ui/doc/*.rst ; However, some modification is required.

  • index.rst should be renamed to Home.rst
  • the embedded links have .html extension, which should be removed for wiki/*.rst

Return to Home

Updated