JuliaBesties / BestieTemplate.jl

Template for Julia Programming Language packages using the copier engine.
http://JuliaBesties.github.io/BestieTemplate.jl/
Mozilla Public License 2.0
52 stars 11 forks source link
best-practices code-quality copier copier-template julia julia-best-practices julia-language julia-template template

BestieTemplate.jl

BestieTemplate.jl

Your best practices friend.

[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaBesties.github.io/BestieTemplate.jl/stable) [![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaBesties.github.io/BestieTemplate.jl/dev) [![Build Status](https://github.com/JuliaBesties/BestieTemplate.jl/workflows/Test/badge.svg)](https://github.com/JuliaBesties/BestieTemplate.jl/actions) [![Test workflow status](https://github.com/JuliaBesties/BestieTemplate.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/JuliaBesties/BestieTemplate.jl/actions/workflows/Test.yml?query=branch%3Amain) [![Lint workflow Status](https://github.com/JuliaBesties/BestieTemplate.jl/actions/workflows/Lint.yml/badge.svg?branch=main)](https://github.com/JuliaBesties/BestieTemplate.jl/actions/workflows/Lint.yml?query=branch%3Amain) [![Docs workflow Status](https://github.com/JuliaBesties/BestieTemplate.jl/actions/workflows/Docs.yml/badge.svg?branch=main)](https://github.com/JuliaBesties/BestieTemplate.jl/actions/workflows/Docs.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/JuliaBesties/BestieTemplate.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaBesties/BestieTemplate.jl) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8350577.svg)](https://doi.org/10.5281/zenodo.8350577) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) [![All Contributors](https://img.shields.io/github/all-contributors/JuliaBesties/BestieTemplate.jl?labelColor=5e1ec7&color=c0ffee&style=flat-square)](#contributors) [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-black.json)](https://github.com/copier-org/copier) [![BestieTemplate](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/JuliaBesties/BestieTemplate.jl/main/docs/src/assets/badge.json)](https://github.com/JuliaBesties/BestieTemplate.jl)

What does BestieTemplate 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 BestieTemplate does.

FAQ

Architecture

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

Quickstart

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

julia> # press ]
pkg> add BestieTemplate

then:

julia> using BestieTemplate
julia> BestieTemplate.generate("path/to/YourNewPackage.jl")
julia> # or BestieTemplate.apply("path/to/YourExistingPackage.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 BestieTemplate 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.

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

πŸ€” πŸ’»
fdiblen
fdiblen

πŸ’» πŸ‘€
Greg Neustroev
Greg Neustroev

πŸ’»
Luca Ferranti
Luca Ferranti

πŸ€”
Guillaume Dalle
Guillaume Dalle

πŸ€”
Johannes Hidding
Johannes Hidding

πŸ› πŸ‘€
Frames White
Frames White

πŸ’» πŸ› πŸ€”
Lauren Clisby
Lauren Clisby

πŸ€” πŸ’»
Diego Alejandro Tejada Arango
Diego Alejandro Tejada Arango

πŸ€”
LeoXia
LeoXia

πŸ’»