PkgTemplates.jl/docs/src/index.md

PkgTemplates

PkgTemplates is a Julia package for creating new Julia packages in an easy, repeatable, and customizable way.

Installation

PkgTemplates is registered in METADATA.jl, so run Pkg.add("PkgTemplates") for the latest release, or Pkg.clone("PkgTemplates") for the development version.

Usage

The simplest template only requires your GitHub username.

using PkgTemplates
t = Template(; user="myusername");
generate("MyPkg", t)
run(`git -C $(joinpath(t.dir, "MyPkg")) ls-tree -r --name-only HEAD`)

However, we can also configure a number of keyword arguments to Template and generate:

using PkgTemplates
t = Template(;
    user="myusername",
    license="MIT",
    authors=["Chris de Graaf", "Invenia Technical Computing Corporation"],
    years="2016-2017",
    dir=joinpath(homedir(), "code"),
    julia_version=v"0.5.2",
    requirements=["PkgTemplates"],
    gitconfig=Dict("diff.renames" => true),
    plugins=[
        TravisCI(),
        CodeCov(),
        Coveralls(),
        AppVeyor(),
        GitHubPages(),
    ],
);
generate("MyPkg", t; force=true, ssh=true)
run(`git -C $(joinpath(t.dir, "MyPkg")) ls-tree -r --name-only HEAD`)

If that looks like a lot of work, you can also create templates interactively with interactive_template:

And if that's still too much work for you, you can call interactive_template with fast=true to use default values for everything but username and plugin selection.

You can also use generate_interactive to interactively generate a template and then immediately use it to create a new package.

Comparison to PkgDev

PkgTemplates is similar in functionality to PkgDev's generate function. However, PkgTemplates offers more customizability in templates and more extensibility via plugins. For the package registration and release management features that PkgTemplates lacks, you are encouraged to use AttoBot instead.