Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cvxgrp/boilerplate

We use this repo to automate and avoid boilerplate issue

https://github.com/cvxgrp/boilerplate

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

We use this repo to automate and avoid boilerplate issue

Basic Info
  • Host: GitHub
  • Owner: cvxgrp
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 270 KB
Statistics
  • Stars: 1
  • Watchers: 4
  • Forks: 0
  • Open Issues: 1
  • Releases: 6
Created almost 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

🍳 cvxcooker

PyPI version Apache 2.0 License Downloads Coverage Status

📋 What is cvxcooker?

This is code to automate the often tedious process of writing boilerplate files such as

  • README.md
  • CONTRIBUTING.md
  • CODEOFCONDUCT.md
  • book/sphinx/conf.py
  • book/_config.yml

All those files are created from Jinja2 templates, e.g. the file 'book/_config.yml' is created from the template

```yaml

Book settings

Learn more at https://jupyterbook.org/customize/config.html

title: {{ name }} author: {{ authors[0] }} onlybuildtoc_files: true

execute: execute_notebooks: force timeout: 240

parse: mystenableextensions: - linkify - dollarmath

needed for plotly

sphinx: config: htmljsfiles: - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js

Information about where the book exists on the web

repository: url: {{ repository }} pathtobook: book branch: main

Add GitHub buttons to your book

See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository

html: useissuesbutton: true userepositorybutton: true extra_navbar: Powered by Jupyter Book # Will be displayed underneath the left navbar. ```

The data in double curly braces is replaced by the data injected into the template. We get the data from parsing the projects 'pyproject.toml' in the root of the repository.

Of course, we do not want to entertain the idea of having copies of all those templates in all the repositories. Instead, we have this central repository and every repository that wants to use this functionality adds in its Makefile the job

make .PHONY: boil boil: ## Update the boilerplate code @poetry run pip install cvxcooker @poetry run cook pyproject.toml

Owner

  • Name: Stanford University Convex Optimization Group
  • Login: cvxgrp
  • Kind: organization
  • Location: Stanford, CA

GitHub Events

Total
  • Create event: 24
  • Issues event: 2
  • Release event: 2
  • Delete event: 25
  • Issue comment event: 1
  • Push event: 43
  • Pull request event: 47
Last Year
  • Create event: 24
  • Issues event: 2
  • Release event: 2
  • Delete event: 25
  • Issue comment event: 1
  • Push event: 43
  • Pull request event: 47

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 2
  • Total pull requests: 19
  • Average time to close issues: 1 day
  • Average time to close pull requests: about 4 hours
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.05
  • Merged pull requests: 17
  • Bot issues: 1
  • Bot pull requests: 11
Past Year
  • Issues: 2
  • Pull requests: 19
  • Average time to close issues: 1 day
  • Average time to close pull requests: about 4 hours
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.05
  • Merged pull requests: 17
  • Bot issues: 1
  • Bot pull requests: 11
View more stats
Top Authors
Issue Authors
  • tschm (1)
  • renovate[bot] (1)
Pull Request Authors
  • dependabot[bot] (27)
  • tschm (11)
  • renovate[bot] (5)
Top Labels
Issue Labels
Pull Request Labels
dependencies (28) python (18) github_actions (7) renovate (3) pre-commit (1)

Dependencies

poetry.lock pypi
  • colorama 0.4.6
  • fire 0.5.0
  • jinja2 3.1.2
  • loguru 0.7.2
  • markupsafe 2.1.3
  • six 1.16.0
  • termcolor 2.3.0
  • toml 0.10.2
  • win32-setctime 1.1.0
pyproject.toml pypi
  • fire *
  • jinja2 *
  • loguru *
  • python >=3.9.0,<3.12
  • toml *
.github/workflows/basic.yml actions
  • actions/checkout v3 composite
  • cvxgrp/.github/actions/test main composite
  • pre-commit/action v3.0.0 composite
.github/workflows/release.yml actions
  • cvxgrp/.github/actions/build main composite
  • cvxgrp/.github/actions/publish main composite