mpp 0.1.5

My Python Project: a command-line tool to create a Python project

My Python Project

Description

A simple tool to create a project with Python, an executable and an installer.

It's only for Windows, but future versions will make it independent of the operating system.

Installation

mpp can be installed using the pip package manager:

$ pip install mpp

Usage

Let's create a project together:

$ mkdir mpp_tuto
$ cd mpp_tuto

Setup your project easily

Just answer the questions, where the default values are between square brackets:

$ mpp setup
What is your project name? [mpp_tuto] MPP Tuto
What is your author name? [username] Name

The project's version is 0.0.0.
The project's icon can be found here: resources/images/icon.ico.
The `main.py` file can now be edited.

Use `mpp --help` to display all possible commands.
Use `mpp <command> -h` to display the help for a command.
Use `mpp config --list` to show your project settings.

Environment

After setuping your environment, some folders and files are created:

mpp_tuto/
    resources/
        images/
            icon.ico
    src/
    .mpp_config
    main.py

• resources/: contains your project's files;
• src/: contains the sources of your project;
• .mpp_config: stores yout project's settings;
• main.py: main python file.

mpp will create 2 more folders after freezing and generating an installer:

mpp_tuto/
    installer/
    target/

• installer/: contains the specification files needed to freeze and generate an installer;
• target/: contains the created executable and installer;

Show your configuration

$ mpp config --list
 -→ name = MPP Tuto
 -→ author = Name
 -→ version = 0.0.0
 -→ console = True
 -→ icon = resources/images/icon.ico
 -→ hidden-imports = []

Edit your configuration

$ mpp config author version
What is your author name? [Name] John
What is the new version? [0.0.0] 0.0.1

Are you sure of your modifications (y/n)? y

Process your project version

Show your project version:

$ mpp version
Project 0.0.0

Increment the version:

$ mpp version +
Project 0.0.1

$ mpp version ++
Project 0.1.0

$ mpp version +
Project 0.1.1

$ mpp version +++
Project 1.0.0

Freeze your project with PyInstaller

If PyInstaller is not installed, mpp asks if it can do it for you:

$ mpp freeze
It seems that PyInstaller is not installed.
Please, consider using `pip install PyInstaller`.
Current pip is path/to/pip.
Do you want to install it now (y/n)? [y]
[pip output]

[PyInstaller outpout]

Executable can be found here: target/Project/Project.exe

If you want to generate only the specification file:

$ mpp freeze --spec

Create an installer for your project with NSIS

If ShellExecAsUSer.dll is not in the installer folder, mpp asks if it can download it for you:

$ mpp installer
NSIS needs "ShellExecAsUser" in order to create the installer.
Do you want to download it (y/n)? [y]

Downloading... Done
[NSIS output]

Installer can be found here: target/Project_setup.exe

If you want to generate only the specification file:

$ mpp installer --spec

Credits

This project was originally inspired from fbs.