API Reference

create_project(package_name::String; template::String, github_username::String, kw...)

A function that generates a package named package_name using a given template.

Required keyword arguments

• package_name::String: The name of the package to be created, used as the directory name. Use names like Foo; do not use extensions like Foo.jl.
• template::String: Template used to create the project (Available: "general", "green").
• github_username::String: GitHub username (for example bhftbootcamp).

Optional keyword arguments

• commit::Bool = true: Create a commit after initializing the project.
• push::Bool = false: Push the commit to the remote repository.
• branch::String = "master": Branch name to use when setting up the repository. Defaults to "master".
• project_dir::String = joinpath(DEPOT_PATH[1], "dev", package_name): Path to the project directory.
• version::VersionNumber = VersionNumber(0, 1, 0): Version of the project, used for initial setup.
• owners::Vector{<:String} = String[]: List of project owners.
• maintainers::Vector{<:String} = String[]: List of project maintainers.
• copyright_holder::String = "bhftbootcamp": Copyright holder of the project.

Examples

julia> create_project(
           package_name = "NumExpr",
           github_username = "bhftbootcamp",
           template = "green",
           version = VersionNumber(0, 1, 0),
           owners = String["bootcampman", ],
           maintainers = String[],
           copyright_holder = "bhftbootcamp",
           branch = "master",
           commit = true,
           push = false,
       )