distributionPackage 0.8.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

• 4 DOI Archive

1 Main Features

• Simple default operation

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

• Specify project path to build package from

• Append manifest files to an existing tar or zip package

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).

Multiple manifest files may also be specified using the --manifests argument. The YAML data from the files are concatenated in the same order as the file names into a single manifest.

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

> makePackage --help

usage: makePackage [-h] [-a] [-m [MANIFEST_PATH [MANIFEST_PATH ...]]]
                   [-o OUTPUT] [-p PACKAGE] [-r PROJECTROOT] [-n] [-z]

Build a distribution package from a manifest

optional arguments:
  -h, --help            show this help message and exit
  -a, --append          Append to an existing distribution package, if it
                        exists. Created otherwise. (default disabled)
  -m [MANIFEST_PATH [MANIFEST_PATH ...]], --manifests [MANIFEST_PATH [MANIFEST_PATH ...]]
                        Manifest file(s) to use to build the package. (default
                        manifest.yml)
  -o OUTPUT, --output OUTPUT
                        Directory to place the generated distribution files.
                        Created if not present. (default ./)
  -p PACKAGE, --package PACKAGE
                        Filename stub of output package, not including suffix
                        or version info. (default distribution-out)
  -r PROJECTROOT, --project-root PROJECTROOT
                        Project root to package files from. (default ./)
  -n, --no-tar          Disable tar, gzip output distribution. (default
                        enabled)
  -z, --zip             Enable zip output distribution. (default disabled)

4 DOI Archive

0.3.0
0.4.0
0.5.0
0.6.0