oe-python-template 0.7.1__py3-none-any.whl → 0.7.2__py3-none-any.whl

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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: oe-python-template
3
- Version: 0.7.1
3
+ Version: 0.7.2
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/
@@ -154,48 +154,32 @@ Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-templ
154
154
 
155
155
  ## Generate a new project
156
156
 
157
- This template is designed to be used with the [copier](https://copier.readthedocs.io/en/stable/) project generator. It allows you to create a new project based on this template and customize it according to your needs.
158
- To generate a new project, follow these steps:
157
+ To generate, build and release a fully functioning project in a few minutes, follow these 5 steps:
159
158
 
160
- **Step 1**: Install homebrew, uv package manager amd further tools. Copy the following code into your terminal and execute it.
159
+ **Step 1**: Execute the following command to install or update tooling.
161
160
  ```shell
162
- if [[ "$OSTYPE" == "linux-gnu"* ]]; then # Install Linux specifics
163
- sudo apt-get update -y && sudo apt-get install curl -y # https://curl.se/
164
- fi
165
- if ! command -v brew &> /dev/null; then # https://brew.sh/
166
- /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
167
- brew update # Update Homebrew bundles
168
- fi
169
- which uv &> /dev/null || brew install uv # https://docs.astral.sh/uv/
170
- which git &> /dev/null || brew install git # https://git-scm.com/
171
- which gpg &> /dev/null || brew install gnupg # https://gnupg.org/
172
- which pinact &> /dev/null || brew install pinact # https://github.com/suzuki-shunsuke/pinact
173
- which jq &> /dev/null || brew install jq # https://jqlang.org/
174
- which libxml2 &> /dev/null || brew install libxml2 # https://en.wikipedia.org/wiki/Libxml2
175
- which act &> /dev/null || brew install act # https://nektosact.com/
176
- which pinact &> /dev/null || brew install pinact # https://github.com/suzuki-shunsuke/pinact
177
- if [[ "$OSTYPE" == "darwin"* ]]; then # Install macOS specifics
178
- which pinentry-mac &> /dev/null || brew install gnupg # https://github.com/GPGTools/pinentry
179
- fi
180
- uv tool install copier # https://copier.readthedocs.io/en/stable/
161
+ # Install Homebrew, uv package manager, copier and further dev tools
162
+ curl -LsSf https://raw.githubusercontent.com/helmut-hoffer-von-ankershoffen/oe-python-template/HEAD/install.sh | sh
181
163
  ```
182
164
 
183
165
  **Step 2**: [Create a repository on GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository), clone to your local machine, and change into it's directory.
184
166
 
185
- **Step 3**: Generate the project. Copy
167
+ **Step 3**: Execute the following command to generate a new project based on this template.
186
168
  ```shell
187
- # ensure to stand in a git repository before executing the next command
169
+ # Ensure to stand in a git repository before executing the next command
188
170
  copier copy --trust gh:helmut-hoffer-von-ankershoffen/oe-python-template .
189
171
  ```
190
172
 
191
- **Step 4**: Perform initial commit and push. Copy the following code into your terminal and execute it.
173
+ **Step 4**: Execute the following commands to push your initial commit to GitHub.
192
174
  ```shell
193
175
  git add .
194
176
  git commit -m "chore: Initial commit"
195
177
  git push
196
178
  ```
197
179
 
198
- Visit your GitHub repository and check the Actions tab. The CI workflow should already be running! The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository.
180
+ Check the [Actions tab](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template/actions) of your GitHub repository: The CI/CD workflow of your project is already running!
181
+
182
+ The workflow will fail at the SonarQube step, as this external service is not yet configured for our new repository. We will configure SonarQube and other services in the next step!
199
183
 
200
184
  Notes:
201
185
  1. Check out [this manual](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) on how to set up signed commits
@@ -4,8 +4,8 @@ oe_python_template/cli.py,sha256=RwVJztulrFbdKRASqdjWLhCM7YNgBoxiP4tvlmekE30,349
4
4
  oe_python_template/constants.py,sha256=Z1c06l5DeRuFxYVLHihHHTYvr8_Qh0nyzVKOe5X3ZNs,350
5
5
  oe_python_template/models.py,sha256=L9uwom3TkuOpN3R30bGKEBQKcrLLEMc-O9e8VVSNTGw,838
6
6
  oe_python_template/service.py,sha256=wHwaD_2oSMle41QKXC64T4uKznUnyuV9d4b9Cu7lIoY,1202
7
- oe_python_template-0.7.1.dist-info/METADATA,sha256=GvbquwzgYRLKvygidMqI14fgytbaUFbQbWn5OSgWSyw,29144
8
- oe_python_template-0.7.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
9
- oe_python_template-0.7.1.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
10
- oe_python_template-0.7.1.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
11
- oe_python_template-0.7.1.dist-info/RECORD,,
7
+ oe_python_template-0.7.2.dist-info/METADATA,sha256=Yw867HkdkCfzObrsJOZPf_oCXOi7wLuAS3XJeXcWAbY,27866
8
+ oe_python_template-0.7.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
9
+ oe_python_template-0.7.2.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
10
+ oe_python_template-0.7.2.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
11
+ oe_python_template-0.7.2.dist-info/RECORD,,