oe-python-template-example 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

{oe_python_template_example-0.0.3.dist-info → oe_python_template_example-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.0.3
+Version: 0.0.4
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -91,9 +91,60 @@ Description-Content-Type: text/markdown
 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 
 Use Cases:
-1) Lorem Ipsum
-2) Dolor Sit Amet
-3) Consectetur Adipiscing Elit
+1) Fast and easy to use project setup
+2) Consistent update of already scaffolded projects to benefit from new and improved features.
+3) Dummy CLI application and service demonstrating example usage of the generated directory structure and build pipeline
+
+## Scaffolding Instructions
+
+Step 1: Install uv package manager and copier
+```shell
+if [[ "$OSTYPE" == "darwin"* ]]; then                 # Install dependencies for macOS X
+  if ! command -v brew &> /dev/null; then             ## Install Homebrew if not present
+    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+  fi
+elif [[ "$OSTYPE" == "linux-gnu"* ]]; then            # Install dependencies for Linux
+  sudo apt-get update -y && sudo apt-get install curl -y # Install curl
+fi
+if ! command -v uvx &> /dev/null; then                # Install uv package manager if not present
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  source $HOME/.local/bin/env
+fi
+uv tool install copier                                # Install copier as global tool
+```
+
+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.
+
+Step 3: Scaffold the project
+```shell
+copier copy gh:helmut-hoffer-von-ankershoffen/oe-python-template .
+```
+Step 4: Setup the local environment
+
+```shell
+uv run nox -s setup_eev
+```
+
+Step 5: Perform inital commit and push
+```shell
+git add .
+git commit -m "feat: Initial commit"
+```
+
+Visit your GitHub repository and check the Actions tab. The CI workflow should fail at the SonarQube step,
+as this external service is not yet configured for our new repository.
+
+Step 6: Follow the instructions in SERVICE_CONNECTIONS.md to setup the connections to external services
+such as Cloudcov, SonarQube Cloud, Read The Docs, Docker.io, GHCR.io and Streamlit Community Cloud.
+
+Step 7: Release the first versions
+```shell
+./bump
+```
+Notes:
+* You can remove this section post having successfully scafolded your project.
+* The following sections refer to the dummy application and service provided by this template.
+  Use them as inspiration and adapt them to your own project.
 
 ## Overview
 
@@ -122,6 +173,7 @@ uvx oe-python-template-example --help              # all CLI commands
 uvx oe-python-template-example command --help      # all options for command
 ```
 
+
 ## Highlights
 
 * Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
@@ -138,6 +190,7 @@ uvx oe-python-template-example command --help      # all options for command
 * 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)
 * Setup for developing inside a [devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) included (supports VSCode and GitHub Codespaces)
 
+
 ## Usage Examples
 
 ### Minimal Python Script:

{oe_python_template_example-0.0.3.dist-info → oe_python_template_example-0.0.4.dist-info}/RECORD

@@ -2,8 +2,8 @@ oe_python_template_example/__init__.py,sha256=-sCwS9lD6CvgWw88f7snBDF947PWIhEupJ
 oe_python_template_example/cli.py,sha256=6giUEesoEuwytZnthiTBH9-ALkiwdkTL4TEb7vsqbGM,1351
 oe_python_template_example/constants.py,sha256=6uQHr2CRgzWQWhUQCRRKiPuFhzKB2iblZk3dIRQ5dDc,358
 oe_python_template_example/service.py,sha256=ZpsZFnnJm_3EqoVqGomfAyIjLVmWJFuJ3G9qatWj5yI,516
-oe_python_template_example-0.0.3.dist-info/METADATA,sha256=14pdHyb-nVnuIUez4_KisfRE_8c1_Qi2JXziy0U-tOo,16712
-oe_python_template_example-0.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template_example-0.0.3.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
-oe_python_template_example-0.0.3.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template_example-0.0.3.dist-info/RECORD,,
+oe_python_template_example-0.0.4.dist-info/METADATA,sha256=-pexoz-5o86urvLccP2wWgrm1s29wUIIgPZDWyuUEnc,18808
+oe_python_template_example-0.0.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template_example-0.0.4.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
+oe_python_template_example-0.0.4.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template_example-0.0.4.dist-info/RECORD,,