COPIERTemplate.jl

Copier OPInionated Evolving Reusable Template

Stable Documentation In development documentation Build Status Test workflow status Lint workflow Status Docs workflow Status Coverage DOI Contributor Covenant All Contributors Copier

What does COPIERTemplate do?

Creating Julia packages involve the creation and edition of many tiny files. Wouldn't it be great to automate this?

This is exactly what COPIERTemplate does.

FAQ

  • How is COPIERTemplate different from PkgTemplates?
    • it can be applied to existing packages
    • it invites to follow some (opinionated) best practices
    • it can be reapplied to acquire updates made to the template
    • it is automatically reapplied through Pull Requests made by the Copier.yml workflow (Work in progress)

Architecture

Under the hood, COPIERTemplate is no more and no less than:

  • a copier template/skeleton for Julia packages (see folder template); and
  • a package that wraps copier in Julia using PythonCall.

Quickstart

Install COPIERTemplate in your chosen environment (we recommend globally) by entering pkg mode by pressing ] and then:

pkg> add COPIERTemplate

then:

julia> using COPIERTemplate
julia> COPIERTemplate.generate("YourPackage.jl")

please note that "YourPackage.jl" can either be a fresh new package or an existing one.

asciicast

If you like what you see, check the full usage guide.

Users and Examples

The following are users and examples of repos using this template, or other templates based on it. Feel free to create a pull request to add your repo.

Contributing

If you would like to get involved in the COPIERTemplate growth, please check our contributing guide. We welcome contributions of many types, including coding, reviewing, creating issues, creating tutorials, interacting with users, etc. Make sure to follow our code of conduct.

If your interest is in developing the package, check the development guide as well.

References

Here is a list of links/repos that include content that we have used for inspiration, or used directly. This is most likely not a complete list, since many of the things included here were based on existing packages and knowledge that we brought from other projects. This also doesn't explain where each file came from or why they are here. You can find some of that information in the Explanation section of the docs.

  • PkgTemplates.jl, naturally. We used it for many years, and in particular for the initial TulipaEnergyModel.jl commit (see below).
  • Netherlands eScience Center's python template includes many of the best practices that we apply here. We used many of the ideas there in a Julia context, and took many non-Julia specific ideas from there.
  • TulipaEnergyModel.jl was the project that motivated this version of a template. From the start we decide to implement many best practices and so we started from a PkgTemplates.jl template and started adding parts of the python template that made sense.
  • The Julia Smooth Optimizers package ecosystem was one of the main motivations to look for a solution that could be applied and reapplied to existing packages, in particular to help maintainers.

Contributors

Abel Soares Siqueira
Abel Soares Siqueira

๐Ÿ’ป ๐Ÿ“† ๐Ÿ“– ๐Ÿšง
Tangi Migot
Tangi Migot

๐Ÿ’ป ๐Ÿ“–
Pablo Rodrรญguez-Sรกnchez
Pablo Rodrรญguez-Sรกnchez

๐Ÿ“– ๐Ÿค”
Olga Lyashevska
Olga Lyashevska

๐Ÿ’ป ๐Ÿ“– ๐Ÿค”
Luisa Orozco
Luisa Orozco

๐Ÿ’ป ๐Ÿ“– ๐Ÿค”
Netherlands eScience Center
Netherlands eScience Center

๐Ÿ’ต
Suvayu Ali
Suvayu Ali

๐Ÿ› ๐Ÿ‘€
Stefan Verhoeven
Stefan Verhoeven

๐Ÿ’ป ๐Ÿค”
Dominique
Dominique

๐Ÿค”