oe-python-template 0.3.2__tar.gz → 0.3.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.copier-answers.yml +1 -1
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.pre-commit-config.yaml +1 -2
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.secrets.baseline +1 -1
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/CHANGELOG.md +14 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/PKG-INFO +4 -4
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/README.md +3 -3
- oe_python_template-0.3.4/RELEASE_NOTES.md +8 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/SERVICE_CONNECTIONS.md +11 -2
- oe_python_template-0.3.4/VERSION +1 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/_readme_main.md +3 -3
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/source/conf.py +1 -1
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/pyproject.toml +2 -2
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/sonar-project.properties +1 -1
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.pre-commit-config.yaml.jinja +1 -2
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/SERVICE_CONNECTIONS.md.jinja +11 -2
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/_readme_main.md.jinja +3 -3
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/tests/cli_test.py.jinja +0 -3
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/uv.lock +1 -1
- oe_python_template-0.3.2/RELEASE_NOTES.md +0 -1
- oe_python_template-0.3.2/VERSION +0 -1
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.act-env +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.act-secret +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.devcontainer/Dockerfile +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.devcontainer/devcontainer.json +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.devcontainer/onCreateCommand +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.devcontainer/postAttachCommand +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.devcontainer/postCreateCommand +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.env.example +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.github/workflows/docker-image-build-publish.yml +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.github/workflows/package-build-publish-release.yml +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.github/workflows/test-and-report.yml +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.gitignore +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.python-version +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.readthedocs.yml +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.vscode/extensions.json +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/.vscode/settings.json +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/CODEOWNERS +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/CONTRIBUTING.md +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/Dockerfile +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/LICENSE +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/_readme_footer.md +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/_readme_header.md +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/bin/git-cliff +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/bump +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/codecov.yml +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/compose.yaml +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/copier.yml +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/Makefile +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/make.bat +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/source/_static/.keep +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/source/contributing.rst +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/source/index.rst +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/source/latexmkrc +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/source/main.rst +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/source/reference.rst +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/docs/source/release-notes.rst +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/examples/__init__.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/examples/jupyter.ipynb +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/examples/notebook.ipynb +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/examples/notebook.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/examples/script.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/examples/streamlit.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/CHANGELOG.md +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/LICENSE-APACHE +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/LICENSE-MIT +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/README.md +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/_git-cliff +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/_git-cliff.ps1 +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/git-cliff.bash +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/git-cliff.elv +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/git-cliff.fish +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/git-cliff-completions +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/git-cliff-mangen +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/man/git-cliff.1 +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0-x86_64-unknown-linux-gnu.tar.gz +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/github-action-run +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/latexmkrc +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/logo.png +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/noxfile.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/renovate.json +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/reports/mypy.xml +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/src/oe_python_template/__init__.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/src/oe_python_template/cli.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/src/oe_python_template/constants.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/src/oe_python_template/service.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.act-env.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.act-secret.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/Dockerfile.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/devcontainer.json.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/onCreateCommand.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/postAttachCommand.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/postCreateCommand.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.env.example.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.github/workflows/docker-image-build-publish.yml.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.github/workflows/package-build-publish-release.yml.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.github/workflows/test-and-report.yml.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.gitignore.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.python-version +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.readthedocs.yml.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.vscode/extensions.json +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.vscode/settings.json.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/CHANGELOG.md +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/CODEOWNERS.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/CONTRIBUTING.md.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/Dockerfile.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/LICENSE.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/VERSION +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/_readme_footer.md.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/_readme_header.md.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/bump.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/codecov.yml.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/compose.yaml.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/Makefile.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/make.bat.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/_static/.keep +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/conf.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/contributing.rst.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/index.rst.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/latexmkrc.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/main.rst.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/reference.rst.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/release-notes.rst.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/examples/__init__.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/examples/notebook.ipynb.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/examples/notebook.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/examples/script.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/examples/streamlit.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/github-action-run.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/latexmkrc.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/logo.png +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/noxfile.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/pyproject.toml.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/sonar-project.properties.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/src/{{ project_name_snake_case }}/__init__.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/src/{{ project_name_snake_case }}/cli.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/src/{{ project_name_snake_case }}/constants.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/src/{{ project_name_snake_case }}/service.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/tests/__init__.py.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/tests/fixtures/.keep +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/{{_copier_conf.answers_file}}.jinja +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/tests/__init__.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/tests/cli_test.py +0 -0
- {oe_python_template-0.3.2 → oe_python_template-0.3.4}/tests/fixtures/.keep +0 -0
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
[🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
|
|
2
2
|
|
|
3
|
+
## [0.3.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.3..0.3.4) - 2025-03-08
|
|
4
|
+
|
|
5
|
+
### 📚 Documentation
|
|
6
|
+
|
|
7
|
+
- Typo - ([67af4eb](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/67af4eb80faf9c30a061627eddae8e134a9e6186))
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## [0.3.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.2..v0.3.3) - 2025-03-08
|
|
11
|
+
|
|
12
|
+
### 📚 Documentation
|
|
13
|
+
|
|
14
|
+
- Polish - ([a7b5e11](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/a7b5e111c6ebce5531a05a0d57aea9680b7a16da))
|
|
15
|
+
|
|
16
|
+
|
|
3
17
|
## [0.3.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.0..v0.3.1) - 2025-03-08
|
|
4
18
|
|
|
5
19
|
### 🚜 Refactor
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: oe-python-template
|
|
3
|
-
Version: 0.3.
|
|
3
|
+
Version: 0.3.4
|
|
4
4
|
Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
|
|
5
5
|
Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
|
|
6
6
|
Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
|
|
@@ -127,7 +127,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
|
|
|
127
127
|
Step 4: Setup the local environment
|
|
128
128
|
|
|
129
129
|
```shell
|
|
130
|
-
uv run nox -s
|
|
130
|
+
uv run nox -s setup_dev
|
|
131
131
|
```
|
|
132
132
|
|
|
133
133
|
Step 5: Perform inital commit and push
|
|
@@ -174,8 +174,8 @@ uvx oe-python-template
|
|
|
174
174
|
The CLI provides extensive help:
|
|
175
175
|
|
|
176
176
|
```shell
|
|
177
|
-
uvx oe-python-template --help
|
|
178
|
-
uvx oe-python-template
|
|
177
|
+
uvx oe-python-template --help # all CLI commands
|
|
178
|
+
uvx oe-python-template hello-world --help # help for specific command
|
|
179
179
|
```
|
|
180
180
|
|
|
181
181
|
|
|
@@ -67,7 +67,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
|
|
|
67
67
|
Step 4: Setup the local environment
|
|
68
68
|
|
|
69
69
|
```shell
|
|
70
|
-
uv run nox -s
|
|
70
|
+
uv run nox -s setup_dev
|
|
71
71
|
```
|
|
72
72
|
|
|
73
73
|
Step 5: Perform inital commit and push
|
|
@@ -114,8 +114,8 @@ uvx oe-python-template
|
|
|
114
114
|
The CLI provides extensive help:
|
|
115
115
|
|
|
116
116
|
```shell
|
|
117
|
-
uvx oe-python-template --help
|
|
118
|
-
uvx oe-python-template
|
|
117
|
+
uvx oe-python-template --help # all CLI commands
|
|
118
|
+
uvx oe-python-template hello-world --help # help for specific command
|
|
119
119
|
```
|
|
120
120
|
|
|
121
121
|
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
## [0.3.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.3.3..v0.3.4) - 2025-03-08
|
|
2
|
+
|
|
3
|
+
### 📚 Documentation
|
|
4
|
+
|
|
5
|
+
- Typo - ([67af4eb](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/67af4eb80faf9c30a061627eddae8e134a9e6186))
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
|
|
30
30
|
## Publishing package to Python Package Index (pypi.org)
|
|
31
31
|
|
|
32
|
-
1. Execute `uv
|
|
32
|
+
1. Execute `uv build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
|
|
33
33
|
2. Sign-Up at https://pypi.org/
|
|
34
34
|
3. Goto https://pypi.org/manage/account/ and create an API token of scope "Entire account", calling it oe-python-template. Copy the value of the token into your clipboard.
|
|
35
|
-
4. Execute `uv
|
|
35
|
+
4. Execute `uv publish`, entering __token__ as username and paste the token from your clipboard as password. This will register your package on PyPI and upload the build files
|
|
36
36
|
5. Goto https://pypi.org/manage/account/ again and delete the previously created token oe-python-template of scope "Entire account".
|
|
37
37
|
6. Now create an new API token, again called oe-python-template, but this time of scope "Project: oe-python-template". Copy the token into your clipboard.
|
|
38
38
|
7. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and delete the previously created token.
|
|
@@ -60,3 +60,12 @@
|
|
|
60
60
|
3. Goto https://share.streamlit.io/new and click "Deploy a public app from GitHub"
|
|
61
61
|
4. Select the oe-python-template repo, for "Main file path" select `examples/streamlit.py`, for App URL enter `oe-python-template`.streamlit.app. Click "Deploy"
|
|
62
62
|
5. Goto https://oe-python-template.streamlit.app
|
|
63
|
+
|
|
64
|
+
## Polishing GitHub repository
|
|
65
|
+
|
|
66
|
+
1. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
|
|
67
|
+
2. Click on the cogs icon in the top right corner next to about
|
|
68
|
+
4. Copy oe-python-template.readthedocs.io into the website field
|
|
69
|
+
3. Copy the description from the pyproject.toml file into the description field
|
|
70
|
+
5. Copy up to 20 tags from the pyproject.toml file into the topics field
|
|
71
|
+
6. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings and upload a soclial media image (e.g. logo.png) into the "Social preview" field
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
0.3.4
|
|
@@ -32,7 +32,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
|
|
|
32
32
|
Step 4: Setup the local environment
|
|
33
33
|
|
|
34
34
|
```shell
|
|
35
|
-
uv run nox -s
|
|
35
|
+
uv run nox -s setup_dev
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
Step 5: Perform inital commit and push
|
|
@@ -79,8 +79,8 @@ uvx oe-python-template
|
|
|
79
79
|
The CLI provides extensive help:
|
|
80
80
|
|
|
81
81
|
```shell
|
|
82
|
-
uvx oe-python-template --help
|
|
83
|
-
uvx oe-python-template
|
|
82
|
+
uvx oe-python-template --help # all CLI commands
|
|
83
|
+
uvx oe-python-template hello-world --help # help for specific command
|
|
84
84
|
```
|
|
85
85
|
|
|
86
86
|
|
|
@@ -25,7 +25,7 @@ extensions = [
|
|
|
25
25
|
project = "oe-python-template"
|
|
26
26
|
author = "Helmut Hoffer von Ankershoffen"
|
|
27
27
|
copyright = f" (c) 2025-{datetime.now(UTC).year}, {author}" # noqa: A001
|
|
28
|
-
version = "0.3.
|
|
28
|
+
version = "0.3.4"
|
|
29
29
|
release = version
|
|
30
30
|
github_username = "helmut-hoffer-von-ankershoffen"
|
|
31
31
|
github_repository = "oe-python-template"
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "oe-python-template"
|
|
3
|
-
version = "0.3.
|
|
3
|
+
version = "0.3.4"
|
|
4
4
|
description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
authors = [
|
|
@@ -242,7 +242,7 @@ source = ["src/"]
|
|
|
242
242
|
|
|
243
243
|
|
|
244
244
|
[tool.bumpversion]
|
|
245
|
-
current_version = "0.3.
|
|
245
|
+
current_version = "0.3.4"
|
|
246
246
|
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
|
|
247
247
|
serialize = ["{major}.{minor}.{patch}"]
|
|
248
248
|
search = "{current_version}"
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
sonar.projectKey=helmut-hoffer-von-ankershoffen_oe-python-template
|
|
2
2
|
sonar.organization=helmut-hoffer-von-ankershoffen
|
|
3
|
-
sonar.projectVersion=0.3.
|
|
3
|
+
sonar.projectVersion=0.3.4
|
|
4
4
|
sonar.projectDescription=🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
|
|
5
5
|
sonar.links.homepage=https://oe-python-template.readthedocs.io/en/latest/
|
|
6
6
|
sonar.links.scm=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
|
|
30
30
|
## Publishing package to Python Package Index (pypi.org)
|
|
31
31
|
|
|
32
|
-
1. Execute `uv
|
|
32
|
+
1. Execute `uv build`. This will generate the build files (wheel and tar.gz) in the `dist` folder
|
|
33
33
|
2. Sign-Up at https://pypi.org/
|
|
34
34
|
3. Goto https://pypi.org/manage/account/ and create an API token of scope "Entire account", calling it {{ github_repository_name }}. Copy the value of the token into your clipboard.
|
|
35
|
-
4. Execute `uv
|
|
35
|
+
4. Execute `uv publish`, entering __token__ as username and paste the token from your clipboard as password. This will register your package on PyPI and upload the build files
|
|
36
36
|
5. Goto https://pypi.org/manage/account/ again and delete the previously created token {{ github_repository_name }} of scope "Entire account".
|
|
37
37
|
6. Now create an new API token, again called {{ github_repository_name }}, but this time of scope "Project: {{ github_repository_name }}". Copy the token into your clipboard.
|
|
38
38
|
7. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and delete the previously created token.
|
|
@@ -60,3 +60,12 @@
|
|
|
60
60
|
3. Goto https://share.streamlit.io/new and click "Deploy a public app from GitHub"
|
|
61
61
|
4. Select the {{ github_repository_name }} repo, for "Main file path" select `examples/streamlit.py`, for App URL enter `{{ streamlit_project_key }}`.streamlit.app. Click "Deploy"
|
|
62
62
|
5. Goto https://{{ streamlit_project_key }}.streamlit.app
|
|
63
|
+
|
|
64
|
+
## Polishing GitHub repository
|
|
65
|
+
|
|
66
|
+
1. Goto {{ github_repository_url_https }}
|
|
67
|
+
2. Click on the cogs icon in the top right corner next to about
|
|
68
|
+
4. Copy {{ readthedocs_project_key }}.readthedocs.io into the website field
|
|
69
|
+
3. Copy the description from the pyproject.toml file into the description field
|
|
70
|
+
5. Copy up to 20 tags from the pyproject.toml file into the topics field
|
|
71
|
+
6. Goto {{ github_repository_url_https }}/settings and upload a soclial media image (e.g. logo.png) into the "Social preview" field
|
|
@@ -32,7 +32,7 @@ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
|
|
|
32
32
|
Step 4: Setup the local environment
|
|
33
33
|
|
|
34
34
|
```shell
|
|
35
|
-
uv run nox -s
|
|
35
|
+
uv run nox -s setup_dev
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
Step 5: Perform inital commit and push
|
|
@@ -79,8 +79,8 @@ uvx {{ pypi_distribution_name}}
|
|
|
79
79
|
The CLI provides extensive help:
|
|
80
80
|
|
|
81
81
|
```shell
|
|
82
|
-
uvx {{ pypi_distribution_name}} --help
|
|
83
|
-
uvx {{ pypi_distribution_name}}
|
|
82
|
+
uvx {{ pypi_distribution_name}} --help # all CLI commands
|
|
83
|
+
uvx {{ pypi_distribution_name}} hello-world --help # help for specific command
|
|
84
84
|
```
|
|
85
85
|
|
|
86
86
|
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
|
oe_python_template-0.3.2/VERSION
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
0.3.2
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/_git-cliff
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/_git-cliff.ps1
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/git-cliff.bash
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/git-cliff.elv
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/git-cliff-2.7.0/completions/git-cliff.fish
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/Dockerfile.jinja
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/devcontainer.json.jinja
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/onCreateCommand.jinja
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/postAttachCommand.jinja
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/.devcontainer/postCreateCommand.jinja
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/contributing.rst.jinja
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/reference.rst.jinja
RENAMED
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/docs/source/release-notes.rst.jinja
RENAMED
|
File without changes
|
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/examples/notebook.ipynb.jinja
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/sonar-project.properties.jinja
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{oe_python_template-0.3.2 → oe_python_template-0.3.4}/template/{{_copier_conf.answers_file}}.jinja
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|