Skip to content

Commit a73306a

Browse files
committed
Update docstring
1 parent a8a77c8 commit a73306a

File tree

4 files changed

+46
-2
lines changed

4 files changed

+46
-2
lines changed

.pre-commit-config.yaml

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,18 @@ repos:
55
- repo: https://github.com/pre-commit/pre-commit-hooks
66
rev: "v4.5.0"
77
hooks:
8+
- id: check-added-large-files
9+
- id: check-docstring-first
10+
- id: check-executables-have-shebangs
811
- id: check-merge-conflict
12+
- id: check-symlinks
13+
- id: check-yaml
14+
args:
15+
- "--allow-multiple-documents"
16+
# https://github.com/pre-commit/pre-commit-hooks/issues/273
17+
- "--unsafe"
18+
- id: detect-private-key
19+
- id: mixed-line-ending
920
- id: debug-statements
1021
- id: trailing-whitespace
1122
args: [--markdown-linebreak-ext=md] # Do not process Markdown files.
@@ -16,7 +27,7 @@ repos:
1627
- id: check-toml
1728

1829
- repo: https://github.com/PyCQA/flake8
19-
rev: "6.1.0"
30+
rev: "7.0.0"
2031
hooks:
2132
- id: flake8
2233
additional_dependencies: [
@@ -30,7 +41,13 @@ repos:
3041
- id: detect-secrets
3142

3243
- repo: https://github.com/astral-sh/ruff-pre-commit
33-
rev: v0.1.5
44+
rev: v0.2.1
3445
hooks:
3546
- id: ruff
47+
args: [--fix]
3648
- id: ruff-format
49+
50+
- repo: https://github.com/gitleaks/gitleaks
51+
rev: v8.18.2
52+
hooks:
53+
- id: gitleaks

OWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
approvers:
2+
- <>
3+
reviewers:
4+
- <>

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
11
# python-template-repository
22
Template repository for python
3+
4+
## How to use
5+
- Use the repo as a github template to create a new repository
6+
- Initiate poetry and follow the instructions
7+
```bash
8+
poetry init
9+
```
10+
- Update the `OWNERS` file relevant sections
11+
- If needed, add more checks in `tox.ini`

tox.ini

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[tox]
2+
envlist = unused-code
3+
skipsdist = True
4+
5+
#Unused code
6+
[testenv:unused-code]
7+
basepython = python3
8+
recreate=True
9+
setenv =
10+
PYTHONPATH = {toxinidir}
11+
deps =
12+
python-utility-scripts
13+
commands =
14+
pyappsutils-unusedcode --exclude-function-prefixes 'process_webhook'

0 commit comments

Comments
 (0)