Merge pull request #1 from dmberezovskyii/PPA-0001

init project structure

Author: dmberezovskyii

.github/workflows/lint.yaml

@@ -0,0 +1,35 @@
+name: Linting
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Install Poetry
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+
+      - name: Install dependencies with Poetry
+        run: |
+          poetry install
+
+      - name: Run Linting
+        run: |
+          poetry run ruff check .

.ruff.toml

@@ -0,0 +1,44 @@
+# Ruff Configuration
+line-length = 88
+indent-width = 4
+output-format = "grouped"
+respect-gitignore = true
+target-version = "py312"
+
+[lint]
+select = [
+    "E",  # Error codes
+    "F",  # Pyflakes
+    "W",  # Warnings
+    "C",  # Complexity
+    "N",  # Naming conventions
+    "I",  # Ignored errors
+    "E501",  # Line too long
+    "N805",  # First argument should be 'self'
+]
+fixable = ["ALL"]  # All fixable errors will be automatically corrected
+
+# Ignored Errors
+ignore = [
+    "E731",  # Do not assign a lambda expression, use a def instead
+    "N801",  # Function name should be lowercase
+    "I001",  # Import convention violation
+    "F631",  # Assert should not be used with a literal
+]
+
+# Regular expression for dummy variables
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+# Excluded Directories and Files
+exclude = [
+    ".pytest_cache",
+    "poetry.lock",
+    "__pypackages__",
+    ".git",
+    ".env",
+    ".ruff_cache"
+]
+
+[format]
+exclude = ["__init__.py"]  # Exclude __init__.py from formatting
+skip-magic-trailing-comma = true  # Skip the trailing comma for magic trailing commas

config.py

@@ -0,0 +1,15 @@
+from dynaconf import Dynaconf
+
+settings = Dynaconf(
+    settings_files=[
+        "settings/settings.yaml",  # Default settings
+        "settings/stage.yaml",     # Development-specific settings
+        "settings/prod.yaml",      # Production-specific settings
+        "settings/.secrets.yaml",  # Sensitive data
+    ],
+    environments=True,
+    load_dotenv=True,
+    envvar_prefix="PW",
+    env_switcher="ENV_FOR_PW",
+    dotenv_path="configs/.env",
+)

conftest.py

@@ -0,0 +1,45 @@
+[tool.poetry]
+name = "appium-framework"
+version = "0.1.0"
+description = "A mobile automation framework using pytest and appium"
+authors = ["Dmytro Berezovskyi <[email protected]>"]
+
+packages = [
+    { include = "src" },
+    { include = "settings" },
+    { include = "drivers", from = "src" },
+    { include = "screens", from = "src" },
+    { include = "utils", from = "src" }
+]
+
+[tool.poetry.dependencies]
+python = "^3.12"
+pytest = "^8.3.4"
+dynaconf = "^3.2.10"
+requests = "^2.31"
+pytest-asyncio = "^0.24.0"
+pytest-html = "^4.1.1"
+
+[tool.poetry.dev-dependencies]
+ruff = "^0.6.8"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+addopts = "-rA -v --env=stage --device-type=android --listeners=events --capture=no -p no:cacheprovider --html=../reports/test_report.html --self-contained-html"
+#asyncio_mode = "auto"
+markers = [
+    { name = "smoke", description = "run smoke tests" },
+    { name = "regression", description = "run regression tests" }
+]
+testpaths = ["tests"]
+python_files = ["*.py"]
+python_classes = [
+    "Test*",
+    "*Test*",
+    "*Test",
+    "*Tests",
+]
+python_functions = ["test_*"]