BestieTemplate
Template for Julia Programming Language packages using the copier engine.
Science Score: 77.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 19 committers (5.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.6%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Template for Julia Programming Language packages using the copier engine.
Basic Info
- Host: GitHub
- Owner: JuliaBesties
- License: mpl-2.0
- Language: Julia
- Default Branch: main
- Homepage: http://JuliaBesties.github.io/BestieTemplate.jl/
- Size: 4.11 MB
Statistics
- Stars: 77
- Watchers: 3
- Forks: 10
- Open Issues: 64
- Releases: 44
Topics
Metadata Files
README.md
BestieTemplate.jl
Your best practices friend.
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
BestieTemplatedifferent fromPkgTemplates?- 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.ymlworkflow (Work in progress)
Architecture
Under the hood, BestieTemplate is no more and no less than:
- a copier template/skeleton for Julia packages (see folder template); and
- a package that wraps
copierin Julia usingPythonCallwith 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.
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.
- This package itself uses the template.
- TulipaIO.jl
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.
AI Coding Assistant Attribution
We use and accepts pull requests with AI coding assistants to help with development, but we expect the committers to understand and be responsible for the code that they introduce. All commits that receive AI assistance should be signed off with:
plaintextt
Co-authored-by: MODEL NAME (FULL MODEL VERSION) <EMAIL>
For example:
plaintextt
Co-authored-by: Claude Code (claude-sonnet-4-20250514) <noreply@anthropic.com>
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
Owner
- Name: JuliaBesties
- Login: JuliaBesties
- Kind: organization
- Repositories: 1
- Profile: https://github.com/JuliaBesties
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: BestieTemplate.jl
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Abel
family-names: Soares Siqueira
email: abel.s.siqueira@gmail.com
affiliation: Netherlands eScience Center
orcid: "https://orcid.org/0000-0003-4451-281X"
identifiers:
- type: doi
value: 10.5281/zenodo.8350577
description: Zenodo Concept DOI
repository-code: "https://github.com/JuliaBesties/BestieTemplate.jl"
license: MPL-2.0
GitHub Events
Total
- Create event: 23
- Commit comment event: 16
- Release event: 5
- Issues event: 36
- Watch event: 28
- Delete event: 25
- Issue comment event: 57
- Push event: 119
- Pull request review comment event: 3
- Pull request review event: 11
- Pull request event: 57
- Fork event: 2
Last Year
- Create event: 23
- Commit comment event: 16
- Release event: 5
- Issues event: 36
- Watch event: 28
- Delete event: 25
- Issue comment event: 57
- Push event: 119
- Pull request review comment event: 3
- Pull request review event: 11
- Pull request event: 57
- Fork event: 2
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Abel Soares Siqueira | a****a@e****l | 288 |
| allcontributors[bot] | 4****] | 30 |
| dependabot[bot] | 4****] | 10 |
| Luisa Orozco | l****o@e****l | 6 |
| Luca Ferranti | 4****i | 3 |
| Olga Lyashevska | o****a@g****m | 3 |
| CompatHelper Julia | c****y@j****g | 2 |
| Stefan Verhoeven | s****n@e****l | 2 |
| github-actions[bot] | 4****] | 2 |
| Tangi Migot | t****t@g****m | 2 |
| Suvayu Ali | f****x@g****m | 2 |
| Carlos Paniagua | c****m@g****m | 1 |
| Dominique | d****n@g****m | 1 |
| Faruk D. | f****n@e****l | 1 |
| Frames White | o****x@u****u | 1 |
| Greg Neustroev | G****v@t****l | 1 |
| Lauren Clisby | l****y@t****l | 1 |
| LeoXia | 1****z | 1 |
| Pablo Rodríguez-Sánchez | p****z@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 58
- Total pull requests: 68
- Average time to close issues: 4 months
- Average time to close pull requests: about 1 month
- Total issue authors: 10
- Total pull request authors: 12
- Average comments per issue: 1.41
- Average comments per pull request: 1.0
- Merged pull requests: 54
- Bot issues: 0
- Bot pull requests: 13
Past Year
- Issues: 38
- Pull requests: 66
- Average time to close issues: 3 months
- Average time to close pull requests: 25 days
- Issue authors: 8
- Pull request authors: 10
- Average comments per issue: 0.47
- Average comments per pull request: 0.92
- Merged pull requests: 54
- Bot issues: 0
- Bot pull requests: 13
Top Authors
Issue Authors
- abelsiqueira (22)
- lucaferranti (4)
- tmigot (2)
- oxinabox (1)
- datejada (1)
- hz-xiaxz (1)
- clizbe (1)
- dependabot[bot] (1)
- dpo (1)
- JuliaTagBot (1)
- allcontributors[bot] (1)
- moble (1)
Pull Request Authors
- abelsiqueira (54)
- github-actions[bot] (11)
- lucaferranti (5)
- allcontributors[bot] (4)
- dependabot[bot] (3)
- hz-xiaxz (2)
- clizbe (2)
- tmigot (2)
- cpaniaguam (2)
- PabRod (1)
- luisaforozco (1)
- lyashevska (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- julia 13 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 17
juliahub.com: BestieTemplate
Template for Julia Programming Language packages using the copier engine.
- Homepage: http://JuliaBesties.github.io/BestieTemplate.jl/
- Documentation: https://docs.juliahub.com/General/BestieTemplate/stable/
- License: MPL-2.0
-
Latest release: 0.16.2
published 10 months ago
Rankings
Dependencies
- julia-actions/setup-julia v1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- julia-actions/cache v1 composite
- julia-actions/setup-julia v1 composite
- JuliaRegistries/TagBot v1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- julia-actions/cache v1 composite
- julia-actions/setup-julia v1 composite
- peter-evans/create-pull-request v5 composite
- actions/checkout v2 composite
- julia-actions/setup-julia v1 composite
- actions/cache v1 composite
- actions/checkout v3 composite
- codecov/codecov-action v1 composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-processcoverage v1 composite
- julia-actions/julia-runtest v1 composite
- julia-actions/setup-julia v1 composite