Skip to content

Commit 8b72cb8

Browse files
chore(deps): update from template
1 parent b4cdd88 commit 8b72cb8

8 files changed

Lines changed: 26 additions & 23 deletions

File tree

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_commit: v0.11.0
1+
_commit: v0.11.3
22
_src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
33
attestations_enabled: true
44
author_email: helmuthva@gmail.com

ATTRIBUTIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10521,7 +10521,7 @@ License: LGPL-2.1-or-later
1052110521

1052210522
```
1052310523

10524-
## oe-python-template-example (0.3.8) - MIT License
10524+
## oe-python-template-example (0.4.0) - MIT License
1052510525

1052610526
🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
1052710527

CLI_REFERENCE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $ oe-python-template-example [OPTIONS] COMMAND [ARGS]...
1414
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
1515
* `--help`: Show this message and exit.
1616

17-
🧠 OE Python Template Example v0.3.8 - built with love in Berlin 🐻
17+
🧠 OE Python Template Example v0.4.0 - built with love in Berlin 🐻
1818

1919
**Commands**:
2020

CONTRIBUTING.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,16 @@
22

33
Thank you for considering contributing to OE Python Template Example!
44

5-
65
## Setup
76

8-
Install or update tools required for development:
9-
10-
```shell
11-
# Install Homebrew, uv package manager, copier and further dev tools
12-
curl -LsSf https://raw.githubusercontent.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/HEAD/install.sh | sh
13-
```
14-
157
[Create a fork](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/fork) and clone your fork using ```git clone URL_OF_YOUR_CLONE```. Then change into the directory of your local OE Python Template Example repository with ```cd oe-python-template-example```.
168

179
If you are one of the committers of https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example you can directly clone via ```git clone git@github.com:helmut-hoffer-von-ankershoffen/oe-python-template-example.git``` and ```cd oe-python-template-example```.
1810

11+
Install or update development dependencies using
12+
```shell
13+
make install
14+
```
1915

2016
## Directory Layout
2117

Makefile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Makefile for running common development tasks
22

33
# Define all PHONY targets
4-
.PHONY: all act audit bump clean dist dist_vercel docs docker_build lint setup setup test test_scheduled test_long_running update_from_template
4+
.PHONY: all act audit bump clean dist dist_vercel docs docker_build install lint setup setup test test_scheduled test_long_running update_from_template
55

66
# Main target i.e. default sessions defined in noxfile.py
77
all:
@@ -30,6 +30,11 @@ act audit bump dist dist_vercel docs lint setup test update_from_template:
3030

3131
# Standalone targets
3232

33+
## Install development dependencies and pre-commit hooks
34+
install:
35+
sh install.sh
36+
pre-commit install
37+
3338
## Run tests marked as scheduled
3439
test_scheduled:
3540
uv run --all-extras nox -s test -p 3.11 -- -m scheduled
@@ -73,6 +78,7 @@ help:
7378
@echo " dist_vercel - Package as Vercel Function into dist_vercel/"
7479
@echo " docs [pdf] - Build documentation (add pdf for PDF format)"
7580
@echo " docker_build - Build Docker image oe-python-template-example"
81+
@echo " install - Install development dependencies and pre-commit hooks"
7682
@echo " lint - Run linting and formatting checks"
7783
@echo " setup - Setup development environment"
7884
@echo " test [3.11|3.12|3.13] - Run tests (for specific Python version)"

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -410,9 +410,9 @@ Nothing yet
410410
## Further Reading
411411

412412
* Inspect our [security policy](https://oe-python-template-example.readthedocs.io/en/latest/security.html) with detailed documentation of checks, tools and principles.
413-
* Check out the [CLI Reference](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.
414-
* Check out the [Library Reference](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.
415-
* Check out the [API Reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
413+
* Check out the [CLI reference](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.
414+
* Check out the [library reference](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.
415+
* Check out the [API reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
416416
* Our [release notes](https://oe-python-template-example.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
417417
* In case you want to help us improve 🧠 OE Python Template Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
418418
* We gratefully acknowledge the [open source projects](https://oe-python-template-example.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!

docs/partials/README_footer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
## Further Reading
22

33
* Inspect our [security policy](https://oe-python-template-example.readthedocs.io/en/latest/security.html) with detailed documentation of checks, tools and principles.
4-
* Check out the [CLI Reference](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.
5-
* Check out the [Library Reference](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.
6-
* Check out the [API Reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
4+
* Check out the [CLI reference](https://oe-python-template-example.readthedocs.io/en/latest/cli_reference.html) with detailed documentation of all CLI commands and options.
5+
* Check out the [library reference](https://oe-python-template-example.readthedocs.io/en/latest/lib_reference.html) with detailed documentation of public classes and functions.
6+
* Check out the [API reference](https://oe-python-template-example.readthedocs.io/en/latest/api_reference_v1.html) with detailed documentation of all API operations and parameters.
77
* Our [release notes](https://oe-python-template-example.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
88
* In case you want to help us improve 🧠 OE Python Template Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
99
* We gratefully acknowledge the [open source projects](https://oe-python-template-example.readthedocs.io/en/latest/attributions.html) that this project builds upon. Thank you to all these wonderful contributors!

docs/source/lib_reference.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@ Library Reference
22
=================
33

44
.. automodule:: oe_python_template_example.hello
5-
:members:
6-
5+
:members:
6+
77
.. automodule:: oe_python_template_example.system
8-
:members:
8+
:members:
99

1010
.. automodule:: oe_python_template_example.utils
11-
:members:
11+
:members:
1212

1313
.. automodule:: oe_python_template_example
14-
:members:
14+
:members:
15+

0 commit comments

Comments
 (0)