Refactor and tidy up

.gitignore

@@ -8,3 +8,33 @@ wheels/
 
 # Virtual environments
 .venv
+
+# PyInstaller build artifacts
+*.spec
+*.exe
+*.dll
+*.so
+*.dylib
+build/
+dist/
+*.manifest
+*.tmp
+*.log
+
+# Local build outputs
+build/l10nUtil/
+build/l10nUtil/localpycs/
+build/l10nUtil/*.toc
+build/l10nUtil/*.pyz
+build/l10nUtil/*.html
+build/l10nUtil/*.txt
+build/l10nUtil/*.zip
+build/l10nUtil/*.pkg
+
+# OS and editor files
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+.DS_Store
+.vscode/
+.idea/

.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
   hooks:
     # Prevents commits to certain branches
     - id: no-commit-to-branch
-      args: ["--branch", "main", "master", ]
+      args: ["--branch", "main", "--branch", "master", ]
     # Checks that large files have not been added. Default cut-off for "large" files is 500kb.
     - id: check-added-large-files
     # Checks python syntax
@@ -76,7 +76,10 @@ repos:
       args: [ --fix ]
     - id: ruff-format
       name: format with ruff
-
+    - id: uv-lock
+      name: Verify uv lock file
+      # Override python interpreter from .python-versions as that is too strict for pre-commit.ci
+      args: ["-p3.13"]
 - repo: local
   hooks:
 

.python-version

@@ -1 +1 @@
-3.13
+3.13.12

pyproject.toml

@@ -1,7 +1,194 @@
+[build-system]
+requires = ["setuptools~=80.9", "wheel"]
+build-backend = "setuptools.build_meta"
 [project]
-name = "nvdal10n"
-version = "0.1.0"
-description = "Add your description here"
-readme = "README.md"
-requires-python = ">=3.13"
-dependencies = []
+name = "nvdaL10n"
+dynamic = ["version"]
+description = "Utilities for translations in NVDA and the add-on template"
+maintainers = [
+	{name = "NV Access", email = "info@nvaccess.org"},
+]
+requires-python = ">=3.13,<3.14"
+classifiers = [
+	"Development Status :: 5 - Production/Stable",
+	"Intended Audience :: End Users/Desktop",
+	"License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
+	"Operating System :: Microsoft :: Windows",
+	"Programming Language :: Python :: 3",
+	"Topic :: Accessibility",
+]
+readme = "readme.md"
+license = {file = "license"}
+dependencies = [
+	"crowdin-api-client==1.21.0",
+	"lxml>=6.0.2",
+	"markdown>=3.10",
+	"markdown-link-attr-modifier==0.2.1",
+	"mdx-gh-links==0.4",
+	"mdx-truly-sane-lists==1.3",
+	"nh3==0.2.19",
+	"requests>=2.32.5",
+	"ruff==0.8.1",
+	"pre-commit==4.0.1",
+	"pyright==1.1.396",
+]
+[project.urls]
+Repository = "https://github.com/nvaccess/nvdaL10n"
+
+[project.optional-dependencies]
+windows-packaging = [
+	"pyinstaller==6.3.0",
+]
+
+[tool.ruff]
+line-length = 110
+
+builtins = [
+	# translation lookup
+	"_",
+	# translation lookup
+	"ngettext",
+	# translation lookup
+	"pgettext",
+	# translation lookup
+	"npgettext",
+]
+
+include = [
+	"*.py",
+]
+
+exclude = [
+	".git",
+	"__pycache__",
+	".venv",
+]
+
+[tool.ruff.format]
+indent-style = "tab"
+line-ending = "lf"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15
+
+[tool.ruff.lint]
+ignore = [
+	# indentation contains tabs
+	"W191",
+]
+logger-objects = ["logHandler.log"]
+
+[tool.pyright]
+venvPath = ".venv"
+venv = "."
+pythonPlatform = "Windows"
+typeCheckingMode = "strict"
+
+include = [
+	"**/*.py",
+]
+
+exclude = [
+	".git",
+	"__pycache__",
+	".venv",
+	# When excluding concrete paths relative to a directory,
+	# not matching multiple folders by name e.g. `__pycache__`,
+	# paths are relative to the configuration file.
+]
+
+# General config
+analyzeUnannotatedFunctions = true
+deprecateTypingAliases = true
+
+# Stricter typing
+strictParameterNoneValue = true
+strictListInference = true
+strictDictionaryInference = true
+strictSetInference = true
+
+# Compliant rules
+reportAbstractUsage = true
+reportArgumentType = true
+reportAssertAlwaysTrue = true
+reportAssertTypeFailure = true
+reportAssignmentType = true
+reportAttributeAccessIssue = true
+reportCallInDefaultInitializer = true
+reportCallIssue = true
+reportConstantRedefinition = true
+reportDuplicateImport = true
+reportFunctionMemberAccess = true
+reportGeneralTypeIssues = true
+reportImplicitOverride = true
+reportImplicitStringConcatenation = true
+reportImportCycles = true
+reportIncompatibleMethodOverride = true
+reportIncompatibleVariableOverride = true
+reportIncompleteStub = true
+reportInconsistentConstructor = true
+reportInconsistentOverload = true
+reportIndexIssue = true
+reportInvalidStringEscapeSequence = true
+reportInvalidStubStatement = true
+reportInvalidTypeArguments = true
+reportInvalidTypeForm = true
+reportInvalidTypeVarUse = true
+reportMatchNotExhaustive = true
+reportMissingImports = true
+reportMissingModuleSource = true
+reportMissingParameterType = true
+reportMissingSuperCall = true
+reportMissingTypeArgument = true
+reportNoOverloadImplementation = true
+reportOperatorIssue = true
+reportOptionalCall = true
+reportOptionalContextManager = true
+reportOptionalIterable = true
+reportOptionalMemberAccess = true
+reportOptionalOperand = true
+reportOptionalSubscript = true
+reportOverlappingOverload = true
+reportPossiblyUnboundVariable = true
+reportPrivateImportUsage = true
+reportPrivateUsage = true
+reportPropertyTypeMismatch = true
+reportRedeclaration = true
+reportReturnType = true
+reportSelfClsParameterName = true
+reportShadowedImports = true
+reportTypeCommentUsage = true
+reportTypedDictNotRequiredAccess = true
+reportUnboundVariable = true
+reportUndefinedVariable = true
+reportUnhashable = true
+reportUninitializedInstanceVariable = true
+reportUnknownArgumentType = true
+reportUnknownLambdaType = true
+reportUnknownMemberType = true
+reportUnknownParameterType = true
+reportUnknownVariableType = true
+reportUnnecessaryCast = true
+reportUnnecessaryComparison = true
+reportUnnecessaryContains = true
+reportUnnecessaryIsInstance = true
+reportUnnecessaryTypeIgnoreComment = true
+reportUnsupportedDunderAll = true
+reportUntypedBaseClass = true
+reportUntypedClassDecorator = true
+reportUntypedFunctionDecorator = true
+reportUntypedNamedTuple = true
+reportUnusedCallResult = true
+reportUnusedClass = true
+reportUnusedCoroutine = true
+reportUnusedExcept = true
+reportUnusedExpression = true
+reportUnusedFunction = true
+reportUnusedImport = true
+reportUnusedVariable = true
+reportWildcardImportFromLibrary = true
+
+reportDeprecated = true
+
+# Can be enabled by generating type stubs for modules via pyright CLI
+reportMissingTypeStubs = false

readme.md

@@ -1,3 +1,21 @@
 # Support for translations in NVDA and the add-on template
 
-This repo is intended to be used as a submodule for [NVDA](https://github.com/nvaccess/nvda) and the [add-on template](https://github.com/nvaccess/addonTemplate).
+This repository is intended to be used as a submodule for [NVDA](https://github.com/nvaccess/nvda) and the [add-on template](https://github.com/nvaccess/addonTemplate).
+
+## Installation and Building an Executable
+
+To install all dependencies (including PyInstaller) and build a standalone executable using [uv](https://github.com/astral-sh/uv):
+
+1. Install all dependencies:
+
+	```sh
+	uv pip install .
+	```
+
+2. Build the executable:
+
+	```sh
+	uv run pyinstaller --onefile source/l10nUtil.py
+	```
+
+The resulting executable will be located in the `dist` directory.