BestieTemplate.jl is a template focused on best practices for package development in Julia.
Your best practices friend.
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.
BestieTemplate
different from PkgTemplates
?
Copier.yml
workflow (Work in progress)Under the hood, BestieTemplate
is no more and no less than:
copier
in Julia using PythonCall
with some convenience functions.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.
If you like what you see, check the full usage guide.
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.
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.
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.
Next Generation Sector-Coupling Models for Optimal Investments and Operation