Dev environment enhancements (#54)

* additional ruff formatting rules

* fix release workflow, update pyproject.toml

* add editorconfig file

Author: trappitsch

.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig is awesome: https://editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Rust and Python
+[*.{py,rs}]
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+# YAML
+[*.yml]
+indent_style = space
+indent_size = 2

.github/workflows/release.yml .github/workflows/release_on_pypi.yml.github/workflows/release.yml renamed to .github/workflows/release_on_pypi.yml

@@ -1,23 +1,24 @@
-name: Release creation
+# Release on PyPi if a realease is created
+
+name: Release on PyPi
 
 on:
-  push:
-    # Sequence of patterns matched against refs/tags
-    tags:
-    - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+  release:
+    types: [created]
 
 env:
   PYTHON_VERSION: "3.12"
 
 jobs:
-  build-linux:
+  deploy:
+    if: github.repository_owner == 'trappitsch'
     name: Release on PyPi
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
       - name: Install the latest version of rye
-        uses: eifinger/setup-rye@v2
+        uses: eifinger/setup-rye@v4
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Sync Rye

pyproject.toml

@@ -40,6 +40,27 @@ docs = [
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.ruff]
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+	"A",    # shadowing built-ins
+	"E",    # style stuff, whitespaces
+	"F",    # pyflakes lints
+	"I",    # sorting
+	"N",    # naming
+	"T100", # breakpoints
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["box-packager", "box"]
+
+[tool.ruff.lint.per-file-ignores]
+"src/box/installer_utils/linux_hlp.py" = ["E501"]
+"src/box/installer_utils/mac_hlp.py" = ["E501"]
+"src/box/installer_utils/windows_hlp.py" = ["E501"]
+
 [tool.rye]
 managed = true
 dev-dependencies = [

src/box/cleaner.py

@@ -1,7 +1,7 @@
 # Clean the project folder
 
-from pathlib import Path
 import shutil
+from pathlib import Path
 
 import box.formatters as fmt
 

src/box/cli.py

@@ -5,14 +5,14 @@
 import rich_click as click
 
 import box
+import box.formatters as fmt
+import box.utils as ut
 from box import env_vars
 from box.cleaner import CleanProject
 from box.config import uninitialize
 from box.initialization import InitializeProject
 from box.installer import CreateInstaller
-import box.formatters as fmt
 from box.packager import PackageApp
-import box.utils as ut
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
@@ -45,7 +45,9 @@ def cli():
     "--gui",
     is_flag=True,
     default=None,
-    help="Set the project as a GUI project. In quiet mode, this will default to `False`.",
+    help=(
+        "Set the project as a GUI project. In quiet mode, this will default to `False`."
+    ),
 )
 @click.option("-e", "--entry", help="Set the app entry for the project.")
 @click.option(

src/box/env_vars.py

@@ -1,4 +1,4 @@
-# Deal with setting and getting environmental variables. Getting all at once is handled in the `config.py`
+# Deal with environmental variables.
 
 from enum import Enum
 

src/box/initialization.py

@@ -4,10 +4,10 @@
 
 import rich_click as click
 
-from box.config import PyProjectParser, pyproject_writer
 import box.formatters as fmt
-from box.packager import PackageApp
 import box.utils as ut
+from box.config import PyProjectParser, pyproject_writer
+from box.packager import PackageApp
 
 
 class InitializeProject:

src/box/installer.py

@@ -1,17 +1,17 @@
 # Create an OS specific installer for GUI or CLI application.
 
 import os
-from pathlib import Path
 import shutil
 import subprocess
 import sys
+from pathlib import Path
 
 import rich_click as click
 
-from box import RELEASE_DIR_NAME
-from box.config import PyProjectParser
 import box.formatters as fmt
 import box.utils as ut
+from box import RELEASE_DIR_NAME
+from box.config import PyProjectParser
 
 
 class CreateInstaller:
@@ -322,11 +322,11 @@ def get_icon(suffix: str = None) -> Path:
         ):
             continue
 
-        for dir in dirs:
-            if dir != "assets":
+        for my_dir in dirs:
+            if my_dir != "assets":
                 continue
 
-            icon_file = Path.cwd().joinpath(f"{root}/{dir}/icon")
+            icon_file = Path.cwd().joinpath(f"{root}/{my_dir}/icon")
 
             if suffix:
                 suffixes = [suffix]  # overwrite exisiting and only check this.

src/box/installer_utils/mac_hlp.py

@@ -1,7 +1,7 @@
 # Helper functions to create Mac Installers
 
-from pathlib import Path
 import shutil
+from pathlib import Path
 
 
 def dmgbuild_settings(target_path: Path, name_pkg: str, icon: Path) -> dict:

src/box/packager.py

@@ -1,20 +1,20 @@
 # Build the project with PyApp
 
 import os
-import sys
-from pathlib import Path
 import shutil
 import subprocess
+import sys
 import tarfile
-from typing import List, Union
 import urllib.request
+from pathlib import Path
+from typing import List, Union
 
 import rich_click as click
 
-from box import BUILD_DIR_NAME, RELEASE_DIR_NAME
-from box.config import PyProjectParser
 import box.formatters as fmt
 import box.utils as ut
+from box import BUILD_DIR_NAME, RELEASE_DIR_NAME
+from box.config import PyProjectParser
 
 PYAPP_SOURCE_URL = "https://github.com/ofek/pyapp/releases/"
 PYAPP_SOURCE_NAME = "source.tar.gz"