Skip to content

Commit

Permalink
Added pre-commit config
Browse files Browse the repository at this point in the history
  • Loading branch information
mudiarto committed Apr 27, 2024
1 parent ffa8b83 commit 3444b40
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 19 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
_docs/
_proc/
_libs/

*.bak
.gitattributes
Expand Down
27 changes: 27 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
default_stages: [ commit, push ]
repos:
# pre-commit formatting hooks
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0 # Replace by any tag/version:
hooks:
- id: trailing-whitespace
- id: check-case-conflict
- id: end-of-file-fixer
- id: check-yaml
args: ["--unsafe"]
- id: check-added-large-files
args: [ '--maxkb=1024' ]
- id: mixed-line-ending
- id: fix-encoding-pragma
- id: debug-statements
- id: check-merge-conflict
- id: check-symlinks
- id: destroyed-symlinks
# - id: no-commit-to-branch # personal project - just do main directly for now
- repo: https://github.com/fastai/nbdev
rev: 2.3.13
hooks:
- id: nbdev_clean
# - id: nbdev_export - no library needed
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
# mudiarto.github.io
# Kusno Mudiarto’s Blog


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

This file will become your README and also the index of your
documentation.
A place to keep my notes and experiment with what I learn. I hope it is
helpful for you too.

## Install
## Links

``` sh
pip install mudiarto.github.io
```
- [GitHub/mudiarto](https://github.com/mudiarto)
- [LinkedIn/mudiarto](https://www.linkedin.com/in/mudiarto/)
- [Twitter/mudiarto](https://twitter.com/mudiarto)

## How to use
#### Credits

Fill me in please! Don’t forget code examples:

``` python
1+1
```

2
- This page was created using [nbdev](https://nbdev.fast.ai/).
25 changes: 25 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#!/usr/bin/env just
# see: https://just.systems/man/en/

#
# general
#

# list all recipes
_default:
@just --list --unsorted --justfile {{justfile()}}

#
# run
#

# preview current notebook
preview:
#!/usr/bin/env bash
nbdev_preview

# prepare notebook before publishing. WARNING: cleanup jupyter output
prepare:
#!/usr/bin/env bash
nbdev_prepare
4 changes: 2 additions & 2 deletions nbs/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@
]
},
{
"metadata": {},
"cell_type": "markdown",
"metadata": {},
"source": ""
},
{
"metadata": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"#### Credits\n",
"* This page was created using [nbdev](https://nbdev.fast.ai/)."
Expand Down
4 changes: 2 additions & 2 deletions settings.ini
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ black_formatting = False

### nbdev ###
doc_path = _docs
lib_path = lib_unused
lib_path = _libs
nbs_path = nbs
recursive = True
tst_flags = notest
Expand All @@ -39,5 +39,5 @@ user = mudiarto

### Optional ###
# requirements = fastcore pandas
# dev_requirements =
# dev_requirements =
# console_scripts =

0 comments on commit 3444b40

Please sign in to comment.