Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abelsiqueira/bestietemplate.jl

Template for Julia Programming Language packages using the copier engine.
https://github.com/abelsiqueira/bestietemplate.jl

best-practices code-quality copier copier-template julia julia-language template

Last synced: 2 days ago
JSON representation

Template for Julia Programming Language packages using the copier engine.

Host: GitHub
URL: https://github.com/abelsiqueira/bestietemplate.jl
Owner: abelsiqueira
License: mpl-2.0
Created: 2023-09-09T22:45:16.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-06-26T21:34:49.000Z (3 months ago)
Last Synced: 2024-06-27T00:42:49.656Z (3 months ago)
Topics: best-practices, code-quality, copier, copier-template, julia, julia-language, template
Language: Julia
Homepage: http://abelsiqueira.com/COPIERTemplate.jl/
Size: 3 MB
Stars: 9
Watchers: 2
Forks: 4
Open Issues: 46
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff

Awesome Lists containing this project

README

        


  



# BestieTemplate.jl

Your best practices friend.



[![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://abelsiqueira.github.io/BestieTemplate.jl/stable)

[![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://abelsiqueira.github.io/BestieTemplate.jl/dev)

[![Build Status](https://github.com/abelsiqueira/BestieTemplate.jl/workflows/Test/badge.svg)](https://github.com/abelsiqueira/BestieTemplate.jl/actions)

[![Test workflow status](https://github.com/abelsiqueira/BestieTemplate.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/abelsiqueira/BestieTemplate.jl/actions/workflows/Test.yml?query=branch%3Amain)

[![Lint workflow Status](https://github.com/abelsiqueira/BestieTemplate.jl/actions/workflows/Lint.yml/badge.svg?branch=main)](https://github.com/abelsiqueira/BestieTemplate.jl/actions/workflows/Lint.yml?query=branch%3Amain)

[![Docs workflow Status](https://github.com/abelsiqueira/BestieTemplate.jl/actions/workflows/Docs.yml/badge.svg?branch=main)](https://github.com/abelsiqueira/BestieTemplate.jl/actions/workflows/Docs.yml?query=branch%3Amain)

[![Coverage](https://codecov.io/gh/abelsiqueira/BestieTemplate.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/abelsiqueira/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/abelsiqueira/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/abelsiqueira/BestieTemplate.jl/main/docs/src/assets/badge.json)](https://github.com/abelsiqueira/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

- How is `BestieTemplate` 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, `BestieTemplate` is no more and no less than:

- a [copier](https://copier.readthedocs.io) template/skeleton for Julia packages (see folder [template](template)); and

- a package that wraps `copier` in Julia using `PythonCall` with some convenience functions.

## Quickstart

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

```julia-repl

julia> # press ]

pkg> add BestieTemplate

```

then:

```julia-repl

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](docs/src/assets/demo.gif)](https://asciinema.org/a/611189)

If you like what you see, check the [full usage guide](https://abelsiqueira.com/BestieTemplate.jl/stable/10-full-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.

- This package itself uses the template.

- [TulipaIO.jl](https://github.com/TulipaEnergy/TulipaIO.jl)

## Contributing

If you would like to get involved in the BestieTemplate growth, please check our [contributing guide](docs/src/90-contributing.md). 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](CODE_OF_CONDUCT.md).

If your interest is in developing the package, check the [development guide](docs/src/91-developer.md) 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](https://abelsiqueira.com/BestieTemplate.jl/stable/20-explanation/) section of the docs.

- [PkgTemplates.jl](https://github.com/JuliaCI/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](https://github.com/NLeSC/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](https://github.com/TulipaEnergy/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](https://jso.dev) 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}
💻 📆 📖 🚧

      
_{Tangi Migot}
💻 📖 👀

      
_{Pablo Rodríguez-Sánchez}
📖 🤔

      
_{Olga Lyashevska}
💻 📖 🤔

      
_{Luisa Orozco}
💻 📖 🤔

      
_{Netherlands eScience Center}
💵

      
_{Suvayu Ali}
🐛 👀 💻

    

    

      
_{Stefan Verhoeven}
💻 🤔

      
_Dominique
🤔 💻

      
_fdiblen
💻 👀

      
_{Greg Neustroev}
💻

      
_{Luca Ferranti}
🤔

      
_{Guillaume Dalle}
🤔

      
_{Johannes Hidding}
🐛 👀

    

    

      
_{Frames White}
💻 🐛 🤔