Need help with PkgTemplates.jl?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
invenia

Description

Create new Julia packages, the easy way

272 Stars 48 Forks MIT License 464 Commits 30 Opened issues

Services available

Need anything else?

PkgTemplates

Stable Dev Build Status Codecov Code Style: Blue

PkgTemplates creates new Julia packages in an easy, repeatable, and customizable way.

Installation

Install with Pkg, just like any other registered Julia package:

pkg> add PkgTemplates  # Press ']' to enter the Pkg REPL mode.

Usage

Creating a

Template
is as simple as:
using PkgTemplates
t = Template()

The no-keywords constructor assumes the existence of some preexisting Git configuration (set with

git config --global
):
  • user.name
    : Your real name, e.g. John Smith.
  • user.email
    : Your email address, eg. [email protected]
  • github.user
    : Your GitHub username: e.g. john-smith.

Once you have a

Template
, use it to generate a package:
t("MyPkg")

However, it's probably desirable to customize the template to your liking with various options and plugins:

t = Template(;
    dir="~/code",
    plugins=[
        Git(; manifest=true, ssh=true),
        Codecov(),
        TravisCI(; x86=true),
        Documenter{TravisCI}(),
    ],
)

For a much more detailled overview, please see the documentation.

Contributing

Issues and pull requests are welcome! For some more specific tips, see the developer documentation.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.