distributionPackage 0.3.0

A packaging utility for creating packages of files for distribution based on a YAML manifest.

A tool for packaging a set of files for distribution using a YAML manifest definition from the packageManifest project.

Contents

• 1 Main Features

• 2 Installation

• 3 Getting Started

1 Main Features

• Simple default operation

• zip or tar-gzip package generation (or both)

• Specify project path to build package from

2 Installation

The simplest way to acquire distributionPackage is using pip.

pip install distributionPackage

It’s highly recommended that you install the package into a Python virtual environment.

3 Getting Started

Define a package manifest in a YAML file. The default name expected by distributionPackage is manifest.yml. The example below constructs a simple manifest for a hypothetical C++ project.

- include:
    files: [ 'README.md', 'LICENSE', 'VERSION' ]
- global-include:
    files: [ '*.h', '*.cpp' ]
- prune:
    directory: 'scripts'

Assuming that you have installed distributionPackage and that the makePackage command is in your path,

makePackage

By default makePackage will acquire the manifest definitions from ./manifest.yml, output a file distribution-out.tar.gz in the current directory and assume that the current directory is the root directory of the project to be packaged (for the basis of constructing the package file names from the manifest).

makePackage --help

Using the --help option will describe the various options available.