Skip to content

packaging.md

Latest commit

 

History

History
51 lines (41 loc) · 2.92 KB

packaging.md

File metadata and controls

51 lines (41 loc) · 2.92 KB

Packaging a cmd2 application for distribution

As a general-purpose tool for building interactive command-line applications, cmd2 is designed to be used in many ways. How you distribute your cmd2 application to customers or end users is up to you. See the Overview of Packaging for Python from the Python Packaging Authority for a thorough discussion of the extensive options within the Python ecosystem.

Publishing to the Python Package Index (PyPI)

The easiest way is to follow the tutorial for Packaging Python Projects. This will show you how to package your application as a Python package and upload it to the Python Package Index (PyPI). Once published there, users will be able to install it using idiomatic Python packaging tools such as pip or uv.

Small tweaks on this process can allow you to publish to private PyPI mirrors such as one hosted on AWS CodeArtifact or a private Artifactory server.

Packaging your application in a container using Docker

Packing your Python application in a Docker container is great when it comes to cross-platform portability and convenience since this container will include all dependencies for your application and run them in an isolated environment which won't conflict with operating system dependencies.

This convenient blog post will show you How to "Dockerize" Your Python Applications.

Packing your application along with Python in an installer

For developers wishing to package a cmd2 application into a single binary image or compressed file, we can recommend all of the following based on personal and professional experience:

  • Nuitka
    • Nuitka is a Python compiler written in Python
    • You feed it your Python app, it does a lot of clever things, and spits out an executable or extension module
    • Particularly convenient if you have IP you wish to protect by obfuscating the Python source code behind your application
  • PyInstaller
    • Freeze (package) Python programs into stand-alone executables
    • PyInstaller bundles a Python application and all its dependencies into a single package
    • The user can run the packaged app without installing a Python interpreter or any modules
  • PyOxidizer
    • A modern Python application packaging and distribution tool implemented in Rust
    • A utility for producing binaries that embed Python and all of your dependencies
    • You can copy a single executable file to another machine and run a Python application contained within. It just works.