{nbdev} integration
These utilities are intended to be used to integrate nbdev into the workflow, alongside some opinionated tools like {poetry}
, and also enforcing some of my personal defaults.
tjdev_nbdev_export
to replacenbdev_export
tjdev_nbdev_version
to replacenbdev_bump_version
tjdev_nbdev_release
to replacenbdev_release_*
tjdev_nbdev_gha
adds nbdev GitHub Actions workflows that work with poetrytjdev_nbdev_gitignore
adds a gitignore that is compatible with poetry and nbdevtjdev_nbdev_theme
adds a theme that is consitent with the blog styletjdev_nbdev_config
adds configurtion to fix linting tools
conform
conform ()
Conform nbdev, quarto, and poetry configuration. Infer information from poetry’s pyproject.toml
and the git repository information and generate:
- a compliant
settings.ini
file for nbdev, - a compliant
_quarto.yml
file for the quarto-based documentation, and - a filled-in
pyproject.toml
for poetry.
Most poetry configs are mapped to the fields that make sense, but for configs that are not present in pyproject.toml, they can be supplied via a [tool.nbdev]
section in pyproject.toml.
export
export ()
Similar to nbdev_export
but with specific modifications.
version
version (rule:str)
Type | Details | |
---|---|---|
rule | str | PEP-440 compliant bump rule |
github_actions
github_actions ()
Add GitHub Actions Workflows for testing and documentation
release
release ()
Creates a release on github and poetry
gitignore
gitignore ()
Appends to the gitignore for nbdev specific ignores.
config
config ()
Creates configuration that allows nbdev to coexist with other tools
theme
theme ()
Adds the TJ Palanca theme to quarto