oe-python-template 0.1.4__tar.gz → 0.2.1__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.
Files changed (145) hide show
  1. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.copier-answers.yml +1 -1
  2. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.secrets.baseline +1 -1
  3. oe_python_template-0.1.4/RELEASE_NOTES.md → oe_python_template-0.2.1/CHANGELOG.md +14 -0
  4. oe_python_template-0.2.1/PKG-INFO +60 -0
  5. oe_python_template-0.2.1/README.md +1 -0
  6. oe_python_template-0.1.4/CHANGELOG.md → oe_python_template-0.2.1/RELEASE_NOTES.md +15 -1
  7. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/SERVICE_CONNECTIONS.md +4 -4
  8. oe_python_template-0.2.1/VERSION +1 -0
  9. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/_readme_main.md +56 -3
  10. oe_python_template-0.2.1/bump +3 -0
  11. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/copier.yml +13 -10
  12. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/source/conf.py +1 -1
  13. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/pyproject.toml +2 -2
  14. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/sonar-project.properties +1 -1
  15. oe_python_template-0.2.1/template/README.md +1 -0
  16. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/SERVICE_CONNECTIONS.md.jinja +4 -4
  17. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/_readme_main.md.jinja +56 -3
  18. oe_python_template-0.2.1/template/bump.jinja +3 -0
  19. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/source/conf.py.jinja +3 -3
  20. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/uv.lock +1 -1
  21. oe_python_template-0.1.4/PKG-INFO +0 -288
  22. oe_python_template-0.1.4/README.md +0 -229
  23. oe_python_template-0.1.4/VERSION +0 -1
  24. oe_python_template-0.1.4/bump +0 -3
  25. oe_python_template-0.1.4/template/bump.jinja +0 -3
  26. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.act-env +0 -0
  27. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.act-secret +0 -0
  28. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.devcontainer/Dockerfile +0 -0
  29. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.devcontainer/devcontainer.json +0 -0
  30. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.devcontainer/onCreateCommand +0 -0
  31. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.devcontainer/postAttachCommand +0 -0
  32. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.devcontainer/postCreateCommand +0 -0
  33. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.env.example +0 -0
  34. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.github/workflows/docker-image-build-publish.yml +0 -0
  35. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.github/workflows/package-build-publish-release.yml +0 -0
  36. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.github/workflows/test-and-report.yml +0 -0
  37. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.gitignore +0 -0
  38. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.pre-commit-config.yaml +0 -0
  39. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.python-version +0 -0
  40. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.readthedocs.yml +0 -0
  41. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.vscode/extensions.json +0 -0
  42. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/.vscode/settings.json +0 -0
  43. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/CODEOWNERS +0 -0
  44. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/CONTRIBUTING.md +0 -0
  45. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/Dockerfile +0 -0
  46. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/LICENSE +0 -0
  47. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/_readme_footer.md +0 -0
  48. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/_readme_header.md +0 -0
  49. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/bin/git-cliff +0 -0
  50. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/codecov.yml +0 -0
  51. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/compose.yaml +0 -0
  52. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/Makefile +0 -0
  53. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/make.bat +0 -0
  54. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/source/_static/.keep +0 -0
  55. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/source/contributing.rst +0 -0
  56. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/source/index.rst +0 -0
  57. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/source/latexmkrc +0 -0
  58. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/source/main.rst +0 -0
  59. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/source/reference.rst +0 -0
  60. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/docs/source/release-notes.rst +0 -0
  61. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/examples/__init__.py +0 -0
  62. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/examples/jupyter.ipynb +0 -0
  63. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/examples/notebook.ipynb +0 -0
  64. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/examples/notebook.py +0 -0
  65. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/examples/script.py +0 -0
  66. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/examples/streamlit.py +0 -0
  67. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/CHANGELOG.md +0 -0
  68. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/LICENSE-APACHE +0 -0
  69. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/LICENSE-MIT +0 -0
  70. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/README.md +0 -0
  71. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/completions/_git-cliff +0 -0
  72. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/completions/_git-cliff.ps1 +0 -0
  73. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/completions/git-cliff.bash +0 -0
  74. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/completions/git-cliff.elv +0 -0
  75. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/completions/git-cliff.fish +0 -0
  76. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/git-cliff-completions +0 -0
  77. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/git-cliff-mangen +0 -0
  78. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0/man/git-cliff.1 +0 -0
  79. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/git-cliff-2.7.0-x86_64-unknown-linux-gnu.tar.gz +0 -0
  80. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/github-action-run +0 -0
  81. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/latexmkrc +0 -0
  82. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/logo.png +0 -0
  83. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/noxfile.py +0 -0
  84. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/src/oe_python_template/__init__.py +0 -0
  85. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/src/oe_python_template/cli.py +0 -0
  86. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/src/oe_python_template/constants.py +0 -0
  87. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/src/oe_python_template/service.py +0 -0
  88. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.act-env.jinja +0 -0
  89. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.act-secret.jinja +0 -0
  90. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.devcontainer/Dockerfile.jinja +0 -0
  91. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.devcontainer/devcontainer.json.jinja +0 -0
  92. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.devcontainer/onCreateCommand.jinja +0 -0
  93. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.devcontainer/postAttachCommand.jinja +0 -0
  94. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.devcontainer/postCreateCommand.jinja +0 -0
  95. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.env.example.jinja +0 -0
  96. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.github/workflows/docker-image-build-publish.yml.jinja +0 -0
  97. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.github/workflows/package-build-publish-release.yml.jinja +0 -0
  98. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.github/workflows/test-and-report.yml.jinja +0 -0
  99. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.gitignore.jinja +0 -0
  100. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.pre-commit-config.yaml.jinja +0 -0
  101. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.python-version +0 -0
  102. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.readthedocs.yml.jinja +0 -0
  103. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.vscode/extensions.json +0 -0
  104. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/.vscode/settings.json +0 -0
  105. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/CHANGELOG.md +0 -0
  106. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/CODEOWNERS.jinja +0 -0
  107. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/CONTRIBUTING.md.jinja +0 -0
  108. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/Dockerfile.jinja +0 -0
  109. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/LICENSE.jinja +0 -0
  110. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/VERSION +0 -0
  111. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/_readme_footer.md.jinja +0 -0
  112. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/_readme_header.md.jinja +0 -0
  113. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/codecov.yml.jinja +0 -0
  114. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/compose.yaml.jinja +0 -0
  115. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/Makefile.jinja +0 -0
  116. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/make.bat.jinja +0 -0
  117. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/source/_static/.keep +0 -0
  118. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/source/contributing.rst.jinja +0 -0
  119. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/source/index.rst.jinja +0 -0
  120. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/source/latexmkrc.jinja +0 -0
  121. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/source/main.rst.jinja +0 -0
  122. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/source/reference.rst.jinja +0 -0
  123. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/docs/source/release-notes.rst.jinja +0 -0
  124. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/examples/__init__.py.jinja +0 -0
  125. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/examples/notebook.ipynb.jinja +0 -0
  126. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/examples/notebook.py.jinja +0 -0
  127. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/examples/script.py.jinja +0 -0
  128. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/examples/streamlit.py.jinja +0 -0
  129. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/github-action-run.jinja +0 -0
  130. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/latexmkrc.jinja +0 -0
  131. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/logo.png +0 -0
  132. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/noxfile.py.jinja +0 -0
  133. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/pyproject.toml.jinja +0 -0
  134. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/sonar-project.properties.jinja +0 -0
  135. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/src/{{ project_name_snake_case }}/__init__.py.jinja +0 -0
  136. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/src/{{ project_name_snake_case }}/cli.py.jinja +0 -0
  137. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/src/{{ project_name_snake_case }}/constants.py.jinja +0 -0
  138. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/src/{{ project_name_snake_case }}/service.py.jinja +0 -0
  139. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/tests/__init__.py.jinja +0 -0
  140. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/tests/cli_test.py.jinja +0 -0
  141. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/tests/fixtures/.keep +0 -0
  142. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/template/{{_copier_conf.answers_file}}.jinja +0 -0
  143. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/tests/__init__.py +0 -0
  144. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/tests/cli_test.py +0 -0
  145. {oe_python_template-0.1.4 → oe_python_template-0.2.1}/tests/fixtures/.keep +0 -0
@@ -1,4 +1,4 @@
1
- _commit: v0.1.3-1-g3c72b2b
1
+ _commit: v0.2.0
2
2
  _src_path: .
3
3
  author_email: helmuthva@gmail.com
4
4
  author_github_username: helmut-hoffer-von-ankershoffen
@@ -123,5 +123,5 @@
123
123
  }
124
124
  ],
125
125
  "results": {},
126
- "generated_at": "2025-03-02T16:35:26Z"
126
+ "generated_at": "2025-03-02T18:20:48Z"
127
127
  }
@@ -1,5 +1,19 @@
1
1
  [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
2
2
 
3
+ ## [0.2.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.0..0.2.1) - 2025-03-02
4
+
5
+ ### 📚 Documentation
6
+
7
+ - Update - ([e718c4c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/e718c4ca41f566e9668566a3ac8cb92b93d93904))
8
+
9
+
10
+ ## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.4..v0.2.0) - 2025-03-02
11
+
12
+ ### 📚 Documentation
13
+
14
+ - Start to document the template and setup process - ([d37c39c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d37c39c518736301aadf1192f9a48c4cfd1ded6e))
15
+
16
+
3
17
  ## [0.1.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.3..v0.1.4) - 2025-03-02
4
18
 
5
19
  ### ⛰️ Features
@@ -0,0 +1,60 @@
1
+ Metadata-Version: 2.4
2
+ Name: oe-python-template
3
+ Version: 0.2.1
4
+ Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
5
+ Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
6
+ Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/
7
+ Project-URL: Source, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template
8
+ Project-URL: Changelog, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/releases
9
+ Project-URL: Issues, https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/issues
10
+ Author-email: Helmut Hoffer von Ankershoffen <helmuthva@gmail.com>
11
+ License: MIT License
12
+
13
+ Copyright (c) [2025] [Helmut Hoffer von Ankershoffen (helmuthva@gmail.com)]
14
+
15
+ Permission is hereby granted, free of charge, to any person obtaining a copy
16
+ of this software and associated documentation files (the "Software"), to deal
17
+ in the Software without restriction, including without limitation the rights
18
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
19
+ copies of the Software, and to permit persons to whom the Software is
20
+ furnished to do so, subject to the following conditions:
21
+
22
+ The above copyright notice and this permission notice shall be included in all
23
+ copies or substantial portions of the Software.
24
+
25
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31
+ SOFTWARE.
32
+ License-File: LICENSE
33
+ Keywords: codecov,docker,oe-python-template,pydantic,python,ruff,typer,uv
34
+ Classifier: Development Status :: 2 - Pre-Alpha
35
+ Classifier: Framework :: Pydantic
36
+ Classifier: Framework :: Pytest
37
+ Classifier: Intended Audience :: Developers
38
+ Classifier: Intended Audience :: End Users/Desktop
39
+ Classifier: License :: OSI Approved :: MIT License
40
+ Classifier: Natural Language :: English
41
+ Classifier: Operating System :: MacOS :: MacOS X
42
+ Classifier: Operating System :: Microsoft :: Windows
43
+ Classifier: Operating System :: POSIX :: Linux
44
+ Classifier: Programming Language :: Python
45
+ Classifier: Programming Language :: Python :: 3
46
+ Classifier: Programming Language :: Python :: 3.11
47
+ Classifier: Programming Language :: Python :: 3.12
48
+ Classifier: Programming Language :: Python :: 3.13
49
+ Classifier: Typing :: Typed
50
+ Requires-Python: <4.0,>=3.11
51
+ Requires-Dist: pydantic>=2.10.6
52
+ Requires-Dist: python-dotenv>=1.0.1
53
+ Requires-Dist: typer>=0.15.1
54
+ Provides-Extra: examples
55
+ Requires-Dist: jupyter>=1.1.1; extra == 'examples'
56
+ Requires-Dist: marimo>=0.11.13; extra == 'examples'
57
+ Requires-Dist: streamlit>=1.42.2; extra == 'examples'
58
+ Description-Content-Type: text/markdown
59
+
60
+ Will be generated from readme_*.md partials.
@@ -0,0 +1 @@
1
+ Will be generated from readme_*.md partials.
@@ -1,6 +1,20 @@
1
1
  [🧠 OE Python Template](https://oe-python-template.readthedocs.io/en/latest/)
2
2
 
3
- ## [0.1.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.3..0.1.4) - 2025-03-02
3
+ ## [0.2.1](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.2.0..v0.2.1) - 2025-03-02
4
+
5
+ ### 📚 Documentation
6
+
7
+ - Update - ([e718c4c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/e718c4ca41f566e9668566a3ac8cb92b93d93904))
8
+
9
+
10
+ ## [0.2.0](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.4..v0.2.0) - 2025-03-02
11
+
12
+ ### 📚 Documentation
13
+
14
+ - Start to document the template and setup process - ([d37c39c](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/commit/d37c39c518736301aadf1192f9a48c4cfd1ded6e))
15
+
16
+
17
+ ## [0.1.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/compare/v0.1.3..v0.1.4) - 2025-03-02
4
18
 
5
19
  ### ⛰️ Features
6
20
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  1. Sign-Up at https://app.codecov.io/
6
6
  2. Configure via https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen
7
- 3. Copy value of `CODECOV_TOKEN` into your clipboard
7
+ 3. Select (o) Repository token. Copy value of `CODECOV_TOKEN` into your clipboard
8
8
  4. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `CODECOV_TOKEN`, pasting the token from your clipboard as value
9
9
  5. Re-run the `CI / test` GitHub job in case you tried before and it failed as Codecov was not yet wired up
10
10
 
@@ -21,7 +21,7 @@
21
21
 
22
22
  ## Generating and publishing documentation via ReadTheDocs (readthedocs.org)
23
23
 
24
- 1. Sign-Up at https://readthed§cs.org/
24
+ 1. Sign-Up at https://readthedocs.org/
25
25
  2. Goto https://app.readthedocs.org/dashboard/import/ and search for your repo by enterin oe-python-template in the search bar
26
26
  3. Select the repo and click Continue, then Next.
27
27
  4. On https://app.readthedocs.org/projects/oe-python-template/ wait for the build of the documentation to finish
@@ -42,8 +42,8 @@
42
42
  ## Publishing Docker images to Docker Hub (docker.io)
43
43
 
44
44
  1. Sign-Up at https://hub.docker.com/
45
- 2. Click on your avatar or profile pic and copy the username belwo that into your clipboard.
46
- 3. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `DOCKER_LOGIN`, setting your username at Docker Hub as the value
45
+ 2. Click on your avatar or profile pic and copy the username below that into your clipboard.
46
+ 3. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `DOCKER_USERNAME`, setting your username at Docker Hub as the value
47
47
  4. Goto https://app.docker.com/settings/personal-access-tokens/create and create a new access token setting the description to oe-python-template, permissions Read & Write & Delete. Copy the value of the token into your clipboard.
48
48
  5. Goto https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/settings/secrets/actions/new and create a new repository secret called `DOCKER_PASSWORD`, pasting the token from your clipboard as the value
49
49
  6. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
@@ -0,0 +1 @@
1
+ 0.2.1
@@ -1,9 +1,60 @@
1
1
  Copier template to scaffold Python projects compliant with best practices and modern tooling.
2
2
 
3
3
  Use Cases:
4
- 1) Lorem Ipsum
5
- 2) Dolor Sit Amet
6
- 3) Consectetur Adipiscing Elit
4
+ 1) Fast and easy to use project setup
5
+ 2) Consistent update of already scaffolded projects to benefit from new and improved features.
6
+ 3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
7
+
8
+ ## Scaffolding Instructions
9
+
10
+ Step 1: Install uv package manager and copier
11
+ ```shell
12
+ if [[ "$OSTYPE" == "darwin"* ]]; then # Install dependencies for macOS X
13
+ if ! command -v brew &> /dev/null; then ## Install Homebrew if not present
14
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
15
+ fi
16
+ elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install dependencies for Linux
17
+ sudo apt-get update -y && sudo apt-get install curl -y # Install curl
18
+ fi
19
+ if ! command -v uvx &> /dev/null; then # Install uv package manager if not present
20
+ curl -LsSf https://astral.sh/uv/install.sh | sh
21
+ source $HOME/.local/bin/env
22
+ fi
23
+ uv tool install copier # Install copier as global tool
24
+ ```
25
+
26
+ Step 2: Now create an empty repo on GitHub and clone it to your local machine in a directory of your choice. Change to that directory.
27
+
28
+ Step 3: Scaffold the project
29
+ ```shell
30
+ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
31
+ ```
32
+ Step 4: Setup the local environment
33
+
34
+ ```shell
35
+ uv run nox -s setup_eev
36
+ ```
37
+
38
+ Step 5: Perform inital commit and push
39
+ ```shell
40
+ git add .
41
+ git commit -m "feat: Initial commit"
42
+ ```
43
+
44
+ Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
45
+ as this external service is not yet configured for our new repository.
46
+
47
+ Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services
48
+ such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
49
+
50
+ Step 7: Release the first versions
51
+ ```shell
52
+ ./bump
53
+ ```
54
+ Notes:
55
+ * You can remove this section post having successfully scafolded your project.
56
+ * The following sections refer to the dummy application and service provided by this template.
57
+ Use them as inspiration and adapt them to your own project.
7
58
 
8
59
  ## Overview
9
60
 
@@ -32,6 +83,7 @@ uvx oe-python-template --help # all CLI commands
32
83
  uvx oe-python-template command --help # all options for command
33
84
  ```
34
85
 
86
+
35
87
  ## Highlights
36
88
 
37
89
  * Copier template to scaffold Python projects compliant with best practices and modern tooling.
@@ -48,6 +100,7 @@ uvx oe-python-template command --help # all options for command
48
100
  * 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/helmuthva/oe-python-template/tags)
49
101
  * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
50
102
 
103
+
51
104
  ## Usage Examples
52
105
 
53
106
  ### Minimal Python Script:
@@ -0,0 +1,3 @@
1
+ #!/bin/sh
2
+ VERSION_PART=${1:-patch}
3
+ uv run bump-my-version bump "$VERSION_PART" && git push
@@ -34,11 +34,14 @@ project_name_snake_case_upper:
34
34
  project_description:
35
35
  type: str
36
36
  help: What does project {{ project_name }} do in one sentence?
37
- placeholder: Python project complying with operational excellence practices.
37
+ placeholder: "Python project complying with operational excellence practices."
38
38
  validator: >-
39
- {% if not project_description.strip() %}
40
- Invalid project description
41
- {% endif %}
39
+ {% if not project_description.strip() %}
40
+ Project description must not be empty.
41
+ {% endif %}
42
+ {% if not project_description.strip().endswith('.') %}
43
+ Project description must end with a dot.
44
+ {% endif %}
42
45
 
43
46
  author_name:
44
47
  type: str
@@ -190,12 +193,12 @@ streamlit_project_key:
190
193
  # - application
191
194
  # - shared library
192
195
  # default: package
193
- #
196
+ #
194
197
  # python_version:
195
198
  # type: str
196
199
  # help: "{% if project_type == 'app' %}Which Python version should your app use?{% else %}What is the minimum Python version your package should support?{% endif %}"
197
200
  # default: "{% if project_type == 'app' %}3.12{% else %}3.10{% endif %}"
198
- #
201
+ #
199
202
  # ci:
200
203
  # type: str
201
204
  # help: Which CI/CD provider would you like to use?
@@ -204,7 +207,7 @@ streamlit_project_key:
204
207
  # GitLab CI/CD: gitlab
205
208
  # default: "{% if 'github' in project_url %}github{% else %}gitlab{% endif %}"
206
209
  # when: "{{ 'github' not in project_url and 'gitlab' not in project_url }}"
207
- #
210
+ #
208
211
  # typing:
209
212
  # type: str
210
213
  # help: Do you want to use optional or strict typing and linting?
@@ -212,18 +215,18 @@ streamlit_project_key:
212
215
  # Optional: optional
213
216
  # Strict: strict
214
217
  # default: optional
215
- #
218
+ #
216
219
  # with_conventional_commits:
217
220
  # type: bool
218
221
  # help: Do you want to follow the Conventional Commits standard (https://www.conventionalcommits.org) for your commit messages?
219
222
  # default: true
220
- #
223
+ #
221
224
  # with_fastapi_api:
222
225
  # type: bool
223
226
  # help: Does your app need a FastAPI API?
224
227
  # default: false
225
228
  # when: "{{ project_type == 'app' }}"
226
- #
229
+ #
227
230
  # with_typer_cli:
228
231
  # type: bool
229
232
  # help: Does your {{ project_type }} need a Typer CLI?
@@ -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.1.4"
28
+ version = "0.2.1"
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.1.4"
3
+ version = "0.2.1"
4
4
  description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
5
5
  readme = "README.md"
6
6
  authors = [
@@ -193,7 +193,7 @@ source = ["src/"]
193
193
 
194
194
 
195
195
  [tool.bumpversion]
196
- current_version = "0.1.4"
196
+ current_version = "0.2.1"
197
197
  parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
198
198
  serialize = ["{major}.{minor}.{patch}"]
199
199
  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.1.4
3
+ sonar.projectVersion=0.2.1
4
4
  sonar.projectDescription=OE Python Template
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
@@ -0,0 +1 @@
1
+ Will be generated from readme_*.md partials.
@@ -4,7 +4,7 @@
4
4
 
5
5
  1. Sign-Up at https://app.codecov.io/
6
6
  2. Configure via https://app.codecov.io/gh/{{ github_repository_owner }}
7
- 3. Copy value of `CODECOV_TOKEN` into your clipboard
7
+ 3. Select (o) Repository token. Copy value of `CODECOV_TOKEN` into your clipboard
8
8
  4. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `CODECOV_TOKEN`, pasting the token from your clipboard as value
9
9
  5. Re-run the `CI / test` GitHub job in case you tried before and it failed as Codecov was not yet wired up
10
10
 
@@ -21,7 +21,7 @@
21
21
 
22
22
  ## Generating and publishing documentation via ReadTheDocs (readthedocs.org)
23
23
 
24
- 1. Sign-Up at https://readthed§cs.org/
24
+ 1. Sign-Up at https://readthedocs.org/
25
25
  2. Goto https://app.readthedocs.org/dashboard/import/ and search for your repo by enterin {{ github_repository_name}} in the search bar
26
26
  3. Select the repo and click Continue, then Next.
27
27
  4. On https://app.readthedocs.org/projects/{{ github_repository_name }}/ wait for the build of the documentation to finish
@@ -42,8 +42,8 @@
42
42
  ## Publishing Docker images to Docker Hub (docker.io)
43
43
 
44
44
  1. Sign-Up at https://hub.docker.com/
45
- 2. Click on your avatar or profile pic and copy the username belwo that into your clipboard.
46
- 3. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `DOCKER_LOGIN`, setting your username at Docker Hub as the value
45
+ 2. Click on your avatar or profile pic and copy the username below that into your clipboard.
46
+ 3. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `DOCKER_USERNAME`, setting your username at Docker Hub as the value
47
47
  4. Goto https://app.docker.com/settings/personal-access-tokens/create and create a new access token setting the description to {{ github_repository_name }}, permissions Read & Write & Delete. Copy the value of the token into your clipboard.
48
48
  5. Goto {{ github_repository_url_https }}/settings/secrets/actions/new and create a new repository secret called `DOCKER_PASSWORD`, pasting the token from your clipboard as the value
49
49
  6. In case your `CI / test` job passed, and you are ready to release and publish, bump the version of your project by executing `bump`. In case you tried before completing this setup script, you can as well go to {{ github_repository_url_https }}/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
@@ -1,9 +1,60 @@
1
1
  {{ project_description }}
2
2
 
3
3
  Use Cases:
4
- 1) Lorem Ipsum
5
- 2) Dolor Sit Amet
6
- 3) Consectetur Adipiscing Elit
4
+ 1) Fast and easy to use project setup
5
+ 2) Consistent update of already scaffolded projects to benefit from new and improved features.
6
+ 3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
7
+
8
+ ## Scaffolding Instructions
9
+
10
+ Step 1: Install uv package manager and copier
11
+ ```shell
12
+ if [[ "$OSTYPE" == "darwin"* ]]; then # Install dependencies for macOS X
13
+ if ! command -v brew &> /dev/null; then ## Install Homebrew if not present
14
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
15
+ fi
16
+ elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install dependencies for Linux
17
+ sudo apt-get update -y && sudo apt-get install curl -y # Install curl
18
+ fi
19
+ if ! command -v uvx &> /dev/null; then # Install uv package manager if not present
20
+ curl -LsSf https://astral.sh/uv/install.sh | sh
21
+ source $HOME/.local/bin/env
22
+ fi
23
+ uv tool install copier # Install copier as global tool
24
+ ```
25
+
26
+ Step 2: Now create an empty repo on GitHub and clone it to your local machine in a directory of your choice. Change to that directory.
27
+
28
+ Step 3: Scaffold the project
29
+ ```shell
30
+ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
31
+ ```
32
+ Step 4: Setup the local environment
33
+
34
+ ```shell
35
+ uv run nox -s setup_eev
36
+ ```
37
+
38
+ Step 5: Perform inital commit and push
39
+ ```shell
40
+ git add .
41
+ git commit -m "feat: Initial commit"
42
+ ```
43
+
44
+ Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
45
+ as this external service is not yet configured for our new repository.
46
+
47
+ Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services
48
+ such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
49
+
50
+ Step 7: Release the first versions
51
+ ```shell
52
+ ./bump
53
+ ```
54
+ Notes:
55
+ * You can remove this section post having successfully scafolded your project.
56
+ * The following sections refer to the dummy application and service provided by this template.
57
+ Use them as inspiration and adapt them to your own project.
7
58
 
8
59
  ## Overview
9
60
 
@@ -32,6 +83,7 @@ uvx {{ pypi_distribution_name}} --help # all CLI commands
32
83
  uvx {{ pypi_distribution_name}} command --help # all options for command
33
84
  ```
34
85
 
86
+
35
87
  ## Highlights
36
88
 
37
89
  * {{ project_description}}
@@ -48,6 +100,7 @@ uvx {{ pypi_distribution_name}} command --help # all options for command
48
100
  * 1-liner for installation and execution of command line interface (CLI) via [uv(x)](https://github.com/astral-sh/uv) or [Docker](https://hub.docker.com/r/{{ docker_io_owner }}/{{ docker_io_image_name }}/tags)
49
101
  * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
50
102
 
103
+
51
104
  ## Usage Examples
52
105
 
53
106
  ### Minimal Python Script:
@@ -0,0 +1,3 @@
1
+ #!/bin/sh
2
+ VERSION_PART=${1:-patch}
3
+ uv run bump-my-version bump "$VERSION_PART" && git push
@@ -75,10 +75,10 @@ html_logo = "../../logo.png"
75
75
  html_theme_options = {
76
76
  "announcement": (
77
77
  '<a target="_blank" href="{{ github_repository_url_https }}">GitHub</a> - ' # noqa: E501
78
- '<a target="_blank" href="https://pypi.org/project/{{ pypi_distribution_name }}">PyPI</a> - '
79
- '<a target="_blank" href="https://hub.docker.com/r/{{ docker_io_owner}}/{{ docker_io_image_name }}/tags">Docker</a> - '
78
+ '<a target="_blank" href="https://pypi.org/project/{{ pypi_distribution_name }}">PyPI</a> - ' # noqa: E501
79
+ '<a target="_blank" href="https://hub.docker.com/r/{{ docker_io_owner}}/{{ docker_io_image_name }}/tags">Docker</a> - ' # noqa: E501
80
80
  '<a target="_blank" href="https://sonarcloud.io/summary/new_code?id={{ sonarqube_key }}">SonarQube</a> - ' # noqa: E501
81
- '<a target="_blank" href="https://app.codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name}}">Codecov</a>'
81
+ '<a target="_blank" href="https://app.codecov.io/gh/{{ github_repository_owner }}/{{ github_repository_name}}">Codecov</a>' # noqa: E501
82
82
  ),
83
83
  }
84
84
 
@@ -1927,7 +1927,7 @@ wheels = [
1927
1927
 
1928
1928
  [[package]]
1929
1929
  name = "oe-python-template"
1930
- version = "0.1.4"
1930
+ version = "0.2.1"
1931
1931
  source = { editable = "." }
1932
1932
  dependencies = [
1933
1933
  { name = "pydantic" },