oe-python-template-example 0.0.3__tar.gz → 0.0.7__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 (81) hide show
  1. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.act-env +1 -1
  2. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.copier-answers.yml +1 -1
  3. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.devcontainer/devcontainer.json +0 -1
  4. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.devcontainer/onCreateCommand +1 -1
  5. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.github/workflows/package-build-publish-release.yml +1 -1
  6. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.github/workflows/test-and-report.yml +5 -10
  7. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.gitignore +1 -0
  8. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.pre-commit-config.yaml +17 -2
  9. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.vscode/extensions.json +0 -1
  10. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.vscode/settings.json +5 -10
  11. oe_python_template_example-0.0.3/RELEASE_NOTES.md → oe_python_template_example-0.0.7/CHANGELOG.md +14 -0
  12. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/CODEOWNERS +1 -1
  13. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/CONTRIBUTING.md +14 -0
  14. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/PKG-INFO +66 -8
  15. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/README.md +61 -4
  16. oe_python_template_example-0.0.7/RELEASE_NOTES.md +8 -0
  17. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/SERVICE_CONNECTIONS.md +4 -4
  18. oe_python_template_example-0.0.7/VERSION +1 -0
  19. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/_readme_header.md +5 -1
  20. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/_readme_main.md +56 -3
  21. oe_python_template_example-0.0.7/bump +7 -0
  22. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/compose.yaml +1 -1
  23. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/source/conf.py +2 -2
  24. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/source/index.rst +3 -3
  25. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/noxfile.py +21 -13
  26. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/pyproject.toml +88 -39
  27. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/sonar-project.properties +2 -2
  28. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/uv.lock +88 -45
  29. oe_python_template_example-0.0.3/CHANGELOG.md +0 -25
  30. oe_python_template_example-0.0.3/VERSION +0 -1
  31. oe_python_template_example-0.0.3/bump +0 -3
  32. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.act-secret +0 -0
  33. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.devcontainer/Dockerfile +0 -0
  34. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.devcontainer/postAttachCommand +0 -0
  35. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.devcontainer/postCreateCommand +0 -0
  36. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.env.example +0 -0
  37. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.github/workflows/docker-image-build-publish.yml +0 -0
  38. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.python-version +0 -0
  39. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.readthedocs.yml +0 -0
  40. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.secrets.baseline +0 -0
  41. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/Dockerfile +0 -0
  42. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/LICENSE +0 -0
  43. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/_readme_footer.md +0 -0
  44. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/bin/git-cliff +0 -0
  45. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/codecov.yml +0 -0
  46. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/Makefile +0 -0
  47. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/make.bat +0 -0
  48. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/source/_static/.keep +0 -0
  49. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/source/contributing.rst +0 -0
  50. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/source/latexmkrc +0 -0
  51. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/source/main.rst +0 -0
  52. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/source/reference.rst +0 -0
  53. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/docs/source/release-notes.rst +0 -0
  54. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/examples/__init__.py +0 -0
  55. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/examples/notebook.ipynb +0 -0
  56. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/examples/notebook.py +0 -0
  57. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/examples/script.py +0 -0
  58. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/examples/streamlit.py +0 -0
  59. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/CHANGELOG.md +0 -0
  60. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/LICENSE-APACHE +0 -0
  61. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/LICENSE-MIT +0 -0
  62. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/README.md +0 -0
  63. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/completions/_git-cliff +0 -0
  64. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/completions/_git-cliff.ps1 +0 -0
  65. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/completions/git-cliff.bash +0 -0
  66. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/completions/git-cliff.elv +0 -0
  67. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/completions/git-cliff.fish +0 -0
  68. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/git-cliff-completions +0 -0
  69. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/git-cliff-mangen +0 -0
  70. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0/man/git-cliff.1 +0 -0
  71. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/git-cliff-2.7.0-x86_64-unknown-linux-gnu.tar.gz +0 -0
  72. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/github-action-run +0 -0
  73. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/latexmkrc +0 -0
  74. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/logo.png +0 -0
  75. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/src/oe_python_template_example/__init__.py +0 -0
  76. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/src/oe_python_template_example/cli.py +0 -0
  77. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/src/oe_python_template_example/constants.py +0 -0
  78. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/src/oe_python_template_example/service.py +0 -0
  79. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/tests/__init__.py +0 -0
  80. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/tests/cli_test.py +0 -0
  81. {oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/tests/fixtures/.keep +0 -0
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.act-env RENAMED
@@ -1,2 +1,2 @@
1
- GITLAB_WORKFLOW_RUNTIME=ACT
1
+ GITHUB_WORKFLOW_RUNTIME=ACT
2
2
  ACTIONS_RUNTIME_TOKEN=TOKEN
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.copier-answers.yml RENAMED
@@ -1,4 +1,4 @@
1
- _commit: v0.1.4
1
+ _commit: v0.3.0
2
2
  _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
3
3
  author_email: helmuthva@gmail.com
4
4
  author_github_username: helmut-hoffer-von-ankershoffen
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.devcontainer/devcontainer.json RENAMED
@@ -21,7 +21,6 @@
21
21
  "charliermarsh.ruff",
22
22
  "codecov.codecov",
23
23
  "donjayamanne.python-environment-manager",
24
- "elagil.pre-commit-helper",
25
24
  "fill-labs.dependi",
26
25
  "github.vscode-github-actions",
27
26
  "github.copilot",
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.devcontainer/onCreateCommand RENAMED
@@ -1,7 +1,7 @@
1
1
  #!/bin/sh
2
2
 
3
3
  echo "onCreateCommand: start"
4
- git config --global --add safe.directory /workspaces/
4
+ git config --global --add safe.directory /workspaces/oe-python-template-example
5
5
  rm -rf .nox
6
6
  rm -rf .venv
7
7
  uv sync --frozen
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.github/workflows/package-build-publish-release.yml RENAMED
@@ -25,7 +25,7 @@ jobs:
25
25
  id: git-cliff
26
26
  with:
27
27
  config: pyproject.toml
28
- args: --verbose
28
+ args: --verbose --latest --strip header
29
29
  env:
30
30
  OUTPUT: RELEASE_NOTES.md
31
31
  GITHUB_REPO: ${{ github.repository }}
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.github/workflows/test-and-report.yml RENAMED
@@ -31,11 +31,6 @@ jobs:
31
31
  enable-cache: true
32
32
  cache-dependency-glob: uv.lock
33
33
 
34
- - uses: actions/setup-node@v4
35
- with:
36
- node-version: 18
37
- - run: npm install @modelcontextprotocol/inspector@0.3.0
38
-
39
34
  - name: Install Python, venv and dependencies
40
35
  run: |
41
36
  uv sync --all-extras --frozen --link-mode=copy
@@ -52,7 +47,7 @@ jobs:
52
47
  fi
53
48
 
54
49
  - name: Print development version info
55
- if: s${{ !startsWith(github.ref, 'refs/tags/v') }}
50
+ if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
56
51
  run: |
57
52
  TOML_VERSION=$(uv run python -c "import tomli; print(tomli.load(open('pyproject.toml', 'rb'))['project']['version'])")
58
53
  echo "Development build - Current version in pyproject.toml: $TOML_VERSION"
@@ -81,7 +76,7 @@ jobs:
81
76
 
82
77
  - name: Upload test results
83
78
  uses: actions/upload-artifact@v4
84
- if: ${{ always() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
79
+ if: ${{ always() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
85
80
  with:
86
81
  name: test-results
87
82
  path: |
@@ -95,18 +90,18 @@ jobs:
95
90
 
96
91
  - name: Upload coverage reports to Codecov
97
92
  uses: codecov/codecov-action@v5
98
- if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
93
+ if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
99
94
  with:
100
95
  token: ${{ secrets.CODECOV_TOKEN }}
101
96
  slug: helmut-hoffer-von-ankershoffen/oe-python-template-example
102
97
 
103
98
  - name: Upload test results to Codecov
104
- if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
99
+ if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
105
100
  uses: codecov/test-results-action@v1
106
101
  with:
107
102
  token: ${{ secrets.CODECOV_TOKEN }}
108
103
  - name: SonarQube Scan
109
- if: ${{ !cancelled() && (env.GITLAB_WORKFLOW_RUNTIME != 'ACT') }}
104
+ if: ${{ !cancelled() && (env.GITHUB_WORKFLOW_RUNTIME != 'ACT') }}
110
105
  uses: SonarSource/sonarqube-scan-action@v4
111
106
  env:
112
107
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.gitignore RENAMED
@@ -43,6 +43,7 @@ vulnerabilities.json
43
43
  licenses.json
44
44
  licenses-inverted.json
45
45
  sbom.json
46
+ mypi_junit.xml
46
47
 
47
48
  # IDE
48
49
  .idea/
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.pre-commit-config.yaml RENAMED
@@ -6,6 +6,22 @@ default_install_hook_types:
6
6
  - post-rewrite
7
7
  fail_fast: true
8
8
  repos:
9
+ - repo: meta
10
+ hooks:
11
+ - id: check-useless-excludes
12
+ - repo: https://github.com/pre-commit/pygrep-hooks
13
+ rev: v1.10.0
14
+ hooks:
15
+ - id: python-check-blanket-noqa
16
+ - id: python-check-blanket-type-ignore
17
+ - id: python-check-mock-methods
18
+ - id: python-no-eval
19
+ - id: python-no-log-warn
20
+ - id: python-use-type-annotations
21
+ - id: rst-backticks
22
+ - id: rst-directive-colons
23
+ - id: rst-inline-touching-normal
24
+ - id: text-unicode-replacement-char
9
25
  - repo: https://github.com/pre-commit/pre-commit-hooks
10
26
  rev: v5.0.0
11
27
  hooks:
@@ -40,10 +56,9 @@ repos:
40
56
  - repo: https://github.com/Yelp/detect-secrets
41
57
  rev: v1.5.0
42
58
  hooks:
43
- - id: detect-secrets
59
+ - id: detect-secrets
44
60
  args: ['--baseline', '.secrets.baseline']
45
61
  additional_dependencies: ["gibberish-detector"]
46
- exclude: package.lock.json
47
62
  - repo: https://github.com/astral-sh/uv-pre-commit
48
63
  # uv version.
49
64
  rev: 0.5.8
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.vscode/extensions.json RENAMED
@@ -3,7 +3,6 @@
3
3
  "charliermarsh.ruff",
4
4
  "codecov.codecov",
5
5
  "donjayamanne.python-environment-manager",
6
- "elagil.pre-commit-helper",
7
6
  "fill-labs.dependi",
8
7
  "github.vscode-github-actions",
9
8
  "github.copilot",
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/.vscode/settings.json RENAMED
@@ -3,7 +3,6 @@
3
3
  "**/__pycache__ ": true
4
4
  },
5
5
  "editor.formatOnSave": true,
6
- "editor.defaultFormatter": "charliermarsh.ruff",
7
6
  "terminal.integrated.scrollback": 100000,
8
7
  "[python]": {
9
8
  "editor.codeActionsOnSave": {
@@ -40,7 +39,7 @@
40
39
  "python.testing.pytestEnabled": true,
41
40
  "python.testing.pytestArgs": [
42
41
  "-v",
43
- "--cov={{ project_name_snake_case }}"
42
+ "--cov=oe_python_template_example"
44
43
  ],
45
44
  "github.copilot.selectedCompletionModel": "gpt-4o-copilot",
46
45
  "github.copilot.nextEditSuggestions.enabled": true,
@@ -65,11 +64,7 @@
65
64
  "github.copilot.chat.generateTests.codeLens": true,
66
65
  "github.copilot.chat.search.semanticTextResults": true,
67
66
  "sonarlint.connectedMode.project": {
68
- "connectionId": "{{ org_name_kebab_case }}",
69
- "projectKey": "{{ org_name_kebab_case }}_{{ project_name_kebab_case }}"
70
- },
71
- "pre-commit-helper.runOnSave": "fixes",
72
- "pre-commit-helper.excludedHookIds": [
73
- "nox"
74
- ],
75
- }
67
+ "connectionId": "helmut-hoffer-von-ankershoffen",
68
+ "projectKey": "helmut-hoffer-von-ankershoffen_oe-python-template-example"
69
+ }
70
+ }
oe_python_template_example-0.0.3/RELEASE_NOTES.md → oe_python_template_example-0.0.7/CHANGELOG.md RENAMED
@@ -1,5 +1,19 @@
1
1
  [🧠 OE Python Template Example](https://oe-python-template-example.readthedocs.io/en/latest/)
2
2
 
3
+ ## [0.0.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.4..0.0.7) - 2025-03-08
4
+
5
+ ### ⚙️ Miscellaneous Tasks
6
+
7
+ - *(template)* Bump - ([355683b](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/355683b69c3ef67461b9d7a562c71fcd5e048ad9))
8
+
9
+
10
+ ## [0.0.4](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.3..v0.0.4) - 2025-03-02
11
+
12
+ ### 📚 Documentation
13
+
14
+ - Update - ([45fbb4d](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/45fbb4d287dc8575bbe5895f14f52186a42e8c56))
15
+
16
+
3
17
  ## [0.0.3](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.2..v0.0.3) - 2025-03-02
4
18
 
5
19
  ### ⚙️ Miscellaneous Tasks
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/CODEOWNERS RENAMED
@@ -1,3 +1,3 @@
1
- # oe_python_template_example code owners
1
+ # oe-python-template-example code owners
2
2
 
3
3
  [*] @helmut-hoffer-von-ankershoffen # noqa
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/CONTRIBUTING.md RENAMED
@@ -111,6 +111,20 @@ docker build -t oe-python-template-example .
111
111
  docker run --env THE_VAR=THE_VALUE oe-python-template-example --help
112
112
  ```
113
113
 
114
+ ### Copier
115
+
116
+ Update scaffold from template
117
+
118
+ ```shell
119
+ copier update --trust --skip-tasks --skip-answered
120
+ ```
121
+
122
+ ### Updating demo application contained within oe-python-template
123
+
124
+ ```shell
125
+ copier copy -r HEAD . . --force --trust
126
+ ```
127
+
114
128
  ## Pull Request Guidelines
115
129
 
116
130
  - **Pre-Commit Hooks:** We use pre-commit hooks to ensure code quality. Please install the pre-commit hooks by running `uv run pre-commit install`. This ensure all tests, linting etc. pass locally before you can commit.
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oe-python-template-example
3
- Version: 0.0.3
3
+ Version: 0.0.7
4
4
  Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
5
5
  Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
6
6
  Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -30,7 +30,7 @@ License: MIT License
30
30
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31
31
  SOFTWARE.
32
32
  License-File: LICENSE
33
- Keywords: codecov,docker,oe-python-template-example,pydantic,python,ruff,typer,uv
33
+ Keywords: act,codecov,copier,cyclonedx,detect-secrets,devcontainer,docker,git-cliff,jupyter,marimo,mypy,nox,oe-python-template,oe-python-template-example,pip-audit,pip-licenses,pre-commit,pydantic,pypi,pytest,python,readthedocs,ruff,sonarcloud,sonarqube,sphinx,streamlit,typer,uv
34
34
  Classifier: Development Status :: 2 - Pre-Alpha
35
35
  Classifier: Framework :: Pydantic
36
36
  Classifier: Framework :: Pytest
@@ -52,9 +52,10 @@ Requires-Dist: pydantic>=2.10.6
52
52
  Requires-Dist: python-dotenv>=1.0.1
53
53
  Requires-Dist: typer>=0.15.1
54
54
  Provides-Extra: examples
55
+ Requires-Dist: jinja2>=3.1.6; extra == 'examples'
55
56
  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'
57
+ Requires-Dist: marimo>=0.11.17; extra == 'examples'
58
+ Requires-Dist: streamlit>=1.43.1; extra == 'examples'
58
59
  Description-Content-Type: text/markdown
59
60
 
60
61
  # 🧠 OE Python Template Example
@@ -71,13 +72,17 @@ Description-Content-Type: text/markdown
71
72
  [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
72
73
  [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
73
74
  [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
75
+ [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
74
76
  [![GitHub - Version](https://img.shields.io/github/v/release/helmut-hoffer-von-ankershoffen/oe-python-template-example?label=GitHub&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)
75
77
  [![GitHub - Commits](https://img.shields.io/github/commit-activity/m/helmut-hoffer-von-ankershoffen/oe-python-template-example/main?label=commits&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)
76
78
  [![PyPI - Version](https://img.shields.io/pypi/v/oe-python-template-example.svg?label=PyPI&logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
77
79
  [![PyPI - Status](https://img.shields.io/pypi/status/oe-python-template-example?logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
78
80
  [![Docker - Version](https://img.shields.io/docker/v/helmuthva/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
79
- [![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
81
+ [![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-example?sort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
80
82
  [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
83
+ [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE3IDE2VjdsLTYgNU0yIDlWOGwxLTFoMWw0IDMgOC04aDFsNCAyIDEgMXYxNGwtMSAxLTQgMmgtMWwtOC04LTQgM0gzbC0xLTF2LTFsMy0zIi8+PC9zdmc+)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)
84
+ [![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces&message=Open&color=blue&logo=github)](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)
85
+
81
86
  <!---
82
87
  [![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
83
88
  [![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/size?color=%2344cc11&tag=latest&label=size&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
@@ -91,9 +96,60 @@ Description-Content-Type: text/markdown
91
96
  Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
92
97
 
93
98
  Use Cases:
94
- 1) Lorem Ipsum
95
- 2) Dolor Sit Amet
96
- 3) Consectetur Adipiscing Elit
99
+ 1) Fast and easy to use project setup
100
+ 2) Consistent update of already scaffolded projects to benefit from new and improved features.
101
+ 3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
102
+
103
+ ## Scaffolding Instructions
104
+
105
+ Step 1: Install uv package manager and copier
106
+ ```shell
107
+ if [[ "$OSTYPE" == "darwin"* ]]; then # Install dependencies for macOS X
108
+ if ! command -v brew &> /dev/null; then ## Install Homebrew if not present
109
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
110
+ fi
111
+ elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install dependencies for Linux
112
+ sudo apt-get update -y && sudo apt-get install curl -y # Install curl
113
+ fi
114
+ if ! command -v uvx &> /dev/null; then # Install uv package manager if not present
115
+ curl -LsSf https://astral.sh/uv/install.sh | sh
116
+ source $HOME/.local/bin/env
117
+ fi
118
+ uv tool install copier # Install copier as global tool
119
+ ```
120
+
121
+ 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.
122
+
123
+ Step 3: Scaffold the project
124
+ ```shell
125
+ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
126
+ ```
127
+ Step 4: Setup the local environment
128
+
129
+ ```shell
130
+ uv run nox -s setup_eev
131
+ ```
132
+
133
+ Step 5: Perform inital commit and push
134
+ ```shell
135
+ git add .
136
+ git commit -m "feat: Initial commit"
137
+ ```
138
+
139
+ Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
140
+ as this external service is not yet configured for our new repository.
141
+
142
+ Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services
143
+ such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
144
+
145
+ Step 7: Release the first versions
146
+ ```shell
147
+ ./bump
148
+ ```
149
+ Notes:
150
+ * You can remove this section post having successfully scafolded your project.
151
+ * The following sections refer to the dummy application and service provided by this template.
152
+ Use them as inspiration and adapt them to your own project.
97
153
 
98
154
  ## Overview
99
155
 
@@ -122,6 +178,7 @@ uvx oe-python-template-example --help # all CLI commands
122
178
  uvx oe-python-template-example command --help # all options for command
123
179
  ```
124
180
 
181
+
125
182
  ## Highlights
126
183
 
127
184
  * Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
@@ -138,6 +195,7 @@ uvx oe-python-template-example command --help # all options for command
138
195
  * 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-example/tags)
139
196
  * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
140
197
 
198
+
141
199
  ## Usage Examples
142
200
 
143
201
  ### Minimal Python Script:
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/README.md RENAMED
@@ -12,13 +12,17 @@
12
12
  [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
13
13
  [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
14
14
  [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
15
+ [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
15
16
  [![GitHub - Version](https://img.shields.io/github/v/release/helmut-hoffer-von-ankershoffen/oe-python-template-example?label=GitHub&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)
16
17
  [![GitHub - Commits](https://img.shields.io/github/commit-activity/m/helmut-hoffer-von-ankershoffen/oe-python-template-example/main?label=commits&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)
17
18
  [![PyPI - Version](https://img.shields.io/pypi/v/oe-python-template-example.svg?label=PyPI&logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
18
19
  [![PyPI - Status](https://img.shields.io/pypi/status/oe-python-template-example?logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
19
20
  [![Docker - Version](https://img.shields.io/docker/v/helmuthva/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
20
- [![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
21
+ [![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-example?sort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
21
22
  [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
23
+ [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE3IDE2VjdsLTYgNU0yIDlWOGwxLTFoMWw0IDMgOC04aDFsNCAyIDEgMXYxNGwtMSAxLTQgMmgtMWwtOC04LTQgM0gzbC0xLTF2LTFsMy0zIi8+PC9zdmc+)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)
24
+ [![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces&message=Open&color=blue&logo=github)](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)
25
+
22
26
  <!---
23
27
  [![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
24
28
  [![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/size?color=%2344cc11&tag=latest&label=size&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
@@ -32,9 +36,60 @@
32
36
  Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
33
37
 
34
38
  Use Cases:
35
- 1) Lorem Ipsum
36
- 2) Dolor Sit Amet
37
- 3) Consectetur Adipiscing Elit
39
+ 1) Fast and easy to use project setup
40
+ 2) Consistent update of already scaffolded projects to benefit from new and improved features.
41
+ 3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
42
+
43
+ ## Scaffolding Instructions
44
+
45
+ Step 1: Install uv package manager and copier
46
+ ```shell
47
+ if [[ "$OSTYPE" == "darwin"* ]]; then # Install dependencies for macOS X
48
+ if ! command -v brew &> /dev/null; then ## Install Homebrew if not present
49
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
50
+ fi
51
+ elif [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install dependencies for Linux
52
+ sudo apt-get update -y && sudo apt-get install curl -y # Install curl
53
+ fi
54
+ if ! command -v uvx &> /dev/null; then # Install uv package manager if not present
55
+ curl -LsSf https://astral.sh/uv/install.sh | sh
56
+ source $HOME/.local/bin/env
57
+ fi
58
+ uv tool install copier # Install copier as global tool
59
+ ```
60
+
61
+ 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.
62
+
63
+ Step 3: Scaffold the project
64
+ ```shell
65
+ copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
66
+ ```
67
+ Step 4: Setup the local environment
68
+
69
+ ```shell
70
+ uv run nox -s setup_eev
71
+ ```
72
+
73
+ Step 5: Perform inital commit and push
74
+ ```shell
75
+ git add .
76
+ git commit -m "feat: Initial commit"
77
+ ```
78
+
79
+ Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
80
+ as this external service is not yet configured for our new repository.
81
+
82
+ Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services
83
+ such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
84
+
85
+ Step 7: Release the first versions
86
+ ```shell
87
+ ./bump
88
+ ```
89
+ Notes:
90
+ * You can remove this section post having successfully scafolded your project.
91
+ * The following sections refer to the dummy application and service provided by this template.
92
+ Use them as inspiration and adapt them to your own project.
38
93
 
39
94
  ## Overview
40
95
 
@@ -63,6 +118,7 @@ uvx oe-python-template-example --help # all CLI commands
63
118
  uvx oe-python-template-example command --help # all options for command
64
119
  ```
65
120
 
121
+
66
122
  ## Highlights
67
123
 
68
124
  * Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
@@ -79,6 +135,7 @@ uvx oe-python-template-example command --help # all options for command
79
135
  * 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-example/tags)
80
136
  * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
81
137
 
138
+
82
139
  ## Usage Examples
83
140
 
84
141
  ### Minimal Python Script:
oe_python_template_example-0.0.7/RELEASE_NOTES.md ADDED
@@ -0,0 +1,8 @@
1
+ ## [0.0.7](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/compare/v0.0.4..v0.0.7) - 2025-03-08
2
+
3
+ ### ⚙️ Miscellaneous Tasks
4
+
5
+ - *(template)* Bump - ([355683b](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commit/355683b69c3ef67461b9d7a562c71fcd5e048ad9))
6
+
7
+
8
+
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/SERVICE_CONNECTIONS.md RENAMED
@@ -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-example/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-example 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-example/ 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-example/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-example/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-example, 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-example/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-example/actions/workflows/package-build-publish-release.yml, click on the failed job, and re-run.
oe_python_template_example-0.0.7/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.7
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/_readme_header.md RENAMED
@@ -12,13 +12,17 @@
12
12
  [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=helmut-hoffer-von-ankershoffen_oe-python-template-example&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_oe-python-template-example)
13
13
  [![Coverage](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example/graph/badge.svg?token=SX34YRP30E)](https://codecov.io/gh/helmut-hoffer-von-ankershoffen/oe-python-template-example)
14
14
  [![Ruff](https://img.shields.io/badge/style-Ruff-blue?color=D6FF65)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
15
+ [![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/blob/main/noxfile.py)
15
16
  [![GitHub - Version](https://img.shields.io/github/v/release/helmut-hoffer-von-ankershoffen/oe-python-template-example?label=GitHub&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/releases)
16
17
  [![GitHub - Commits](https://img.shields.io/github/commit-activity/m/helmut-hoffer-von-ankershoffen/oe-python-template-example/main?label=commits&style=flat&labelColor=1C2C2E&color=blue&logo=GitHub&logoColor=white)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/commits/main/)
17
18
  [![PyPI - Version](https://img.shields.io/pypi/v/oe-python-template-example.svg?label=PyPI&logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
18
19
  [![PyPI - Status](https://img.shields.io/pypi/status/oe-python-template-example?logo=pypi&logoColor=%23FFD243&labelColor=%230073B7&color=FDFDFD)](https://pypi.python.org/pypi/oe-python-template-example)
19
20
  [![Docker - Version](https://img.shields.io/docker/v/helmuthva/oe-python-template-example?sort=semver&label=Docker&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/tags)
20
- [![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-examplesort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
21
+ [![Docker - Size](https://img.shields.io/docker/image-size/helmuthva/oe-python-template-example?sort=semver&arch=arm64&label=image&logo=docker&logoColor=white&labelColor=1354D4&color=10151B)](https://hub.docker.com/r/helmuthva/oe-python-template-example/)
21
22
  [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template)
23
+ [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE3IDE2VjdsLTYgNU0yIDlWOGwxLTFoMWw0IDMgOC04aDFsNCAyIDEgMXYxNGwtMSAxLTQgMmgtMWwtOC04LTQgM0gzbC0xLTF2LTFsMy0zIi8+PC9zdmc+)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example)
24
+ [![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces&message=Open&color=blue&logo=github)](https://github.com/codespaces/new/helmut-hoffer-von-ankershoffen/oe-python-template-example)
25
+
22
26
  <!---
23
27
  [![ghcr.io - Version](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/tags?color=%2344cc11&ignore=0.0%2C0%2Clatest&n=3&label=ghcr.io&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
24
28
  [![ghcr.io - Sze](https://ghcr-badge.egpl.dev/helmut-hoffer-von-ankershoffen/oe-python-template-example/size?color=%2344cc11&tag=latest&label=size&trim=)](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example/pkgs/container/oe-python-template-example)
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/_readme_main.md RENAMED
@@ -1,9 +1,60 @@
1
1
  Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
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-example --help # all CLI commands
32
83
  uvx oe-python-template-example command --help # all options for command
33
84
  ```
34
85
 
86
+
35
87
  ## Highlights
36
88
 
37
89
  * Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
@@ -48,6 +100,7 @@ uvx oe-python-template-example 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-example/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:
oe_python_template_example-0.0.7/bump ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/sh
2
+ VERSION_PART=${1:-patch}
3
+ if echo "$VERSION_PART" | grep -qE '^[0-9]+\.[0-9]+\.[0-9]+$'; then
4
+ uv run bump-my-version bump --new-version "$VERSION_PART" && git push
5
+ else
6
+ uv run bump-my-version bump "$VERSION_PART" && git push
7
+ fi
{oe_python_template_example-0.0.3 → oe_python_template_example-0.0.7}/compose.yaml RENAMED
@@ -1,5 +1,5 @@
1
1
  services:
2
- oe_python_template_example:
2
+ oe-python-template-example:
3
3
  build: .
4
4
  env_file:
5
5
  - path: .env