Ruff

Author: MoonBoi9001

.github/README.md

@@ -22,9 +22,17 @@
 ## Local Development
 
 **Before pushing:**
-```bash
-./scripts/ruff_check_format_assets.sh
-```
+   ```bash
+   # Setup venv
+   python3 -m venv venv
+   source venv/bin/activate
+
+   # Install requirements
+   pip install -r requirements.txt
+
+   # Use the custom ruff script for linting (includes SQL formatting and aggressive linting)
+   ./scripts/ruff_check_format_assets.sh
+   ```
 
 **Optional checks:**
 ```bash

.github/workflows/ci.yml

@@ -97,4 +97,4 @@ jobs:
           docker rm test-container
 
       - name: Validate Docker Compose
-        run: docker-compose config 
+        run: docker compose config 

.github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: Test Suite
+name: Tests
 
 on:
   pull_request:
@@ -62,7 +62,7 @@ jobs:
           pip install pytest
 
       - name: Validate Docker setup
-        run: docker-compose config > /dev/null
+        run: docker compose config > /dev/null
 
       - name: Run integration tests
         run: |

.gitignore

@@ -10,7 +10,7 @@ data/
 postgres_data/
 logs/
 subgraph/
-contracts/
+contracts/contract.abi.json
 
 # Ignore Ruff
 .ruff_cache/

README.md

@@ -65,19 +65,28 @@ For details: [.github/README.md](./.github/README.md)
 
 For contributors working on the codebase:
 
-1. **Run local quality checks**:
+**Before pushing:**
    ```bash
-   # Use the custom ruff script (includes SQL formatting and aggressive linting)
-   ./scripts/ruff_check_format_assets.sh
+   # Setup venv
+   python3 -m venv venv
+   source venv/bin/activate
 
-   # Type checking
-   mypy src/ --ignore-missing-imports
+   # Install requirements
+   pip install -r requirements.txt
 
-   # Security scanning
-   bandit -r src/
+   # Use the custom ruff script for linting (includes SQL formatting and aggressive linting)
+   ./scripts/ruff_check_format_assets.sh
    ```
 
-**Note:** The CI/CD pipeline uses the custom `ruff_check_format_assets.sh` script which includes SQL whitespace fixes and more aggressive formatting than standard ruff. Always run this script locally before pushing to avoid CI failures.
+**Optional checks:**
+```bash
+mypy src/ --ignore-missing-imports
+bandit -r src/
+```
+
+> **Note:** The CI/CD pipeline uses the custom `ruff_check_format_assets.sh` script which includes SQL whitespace fixes and more aggressive formatting than standard ruff. 
+> 
+> Always run this script locally before pushing to avoid CI failures.
 
 ## License
 

src/models/bigquery_data_access_provider.py

@@ -54,7 +54,7 @@ def _read_gbq_dataframe(self, query: str) -> DataFrame:
                 logger.warning(f"GOOGLE_APPLICATION_CREDENTIALS path not found: {creds_path}")
                 logger.warning("Falling back to gcloud CLI user credentials.")
             else:
-                logger.info(f"Using enviroment variable $GOOGLE_APPLICATION_CREDENTIALS for authentication.")
+                logger.info("Using enviroment variable $GOOGLE_APPLICATION_CREDENTIALS for authentication.")
         else:
             logger.warning("GOOGLE_APPLICATION_CREDENTIALS not set, falling back to gcloud CLI user credentials")
 

src/models/issuance_data_access_helper.py

@@ -11,17 +11,17 @@
 from pathlib import Path
 
 import pandas as pd
+from tenacity import retry, stop_after_attempt, wait_exponential
 from web3 import Web3
 from web3.contract import Contract
-from tenacity import retry, stop_after_attempt, wait_exponential
 
 # Import data providers
 from src.models.bigquery_data_access_provider import BigQueryProvider
 from src.models.subgraph_data_access_provider import SubgraphProvider
 
 # Import configuration and key validation
 from src.utils.config_loader import ConfigLoader, ConfigurationError
-from src.utils.key_validator import validate_and_format_private_key, KeyValidationError
+from src.utils.key_validator import KeyValidationError, validate_and_format_private_key
 
 logger = logging.getLogger(__name__)
 
@@ -34,7 +34,7 @@
 def _validate_required_fields(data: dict, required_fields: list[str], context: str) -> None:
     """
     Helper function to validate required fields are present in a dictionary.
-    
+
     Args:
         data: Dictionary to validate
         required_fields: List of required fields
@@ -96,7 +96,13 @@ def _load_config_and_return_validated() -> dict[str, str | int | list]:
                 ) from e
 
         # Validate blockchain configuration contains all required fields
-        required_fields = ["private_key", "contract_address", "contract_function", "chain_id", "scheduled_run_time"]
+        required_fields = [
+            "private_key",
+            "contract_address",
+            "contract_function",
+            "chain_id",
+            "scheduled_run_time",
+        ]
         _validate_required_fields(config, required_fields, "Missing required blockchain configuration")
 
         # Validate RPC providers
@@ -133,9 +139,7 @@ def _get_path_to_project_root() -> Path:
         current_path = current_path.parent
 
     # If we got here, something is wrong
-    raise FileNotFoundError(
-        "Could not find project root directory. Investigate."
-    )
+    raise FileNotFoundError("Could not find project root directory. Investigate.")
 
 
 def _parse_and_validate_credentials_json(creds_env: str) -> dict:
@@ -265,7 +269,7 @@ def _setup_google_credentials_in_memory_from_env_var():
             if creds_data is not None:
                 creds_data.clear()
                 del creds_data
-    
+
     else:
         logger.warning(
             "GOOGLE_APPLICATION_CREDENTIALS is not set or not in the correct format. "
@@ -339,7 +343,7 @@ def _clean_old_date_directories(data_output_dir: Path, max_age_before_deletion:
             if age_days > max_age_before_deletion:
                 logger.info(f"Removing old data directory: {item} ({age_days} days old)")
                 shutil.rmtree(item)
-        
+
         # Skip directories that don't match date format
         except ValueError:
             continue
@@ -423,7 +427,7 @@ def _setup_transaction_account(private_key: str, w3) -> tuple[str, object]:
         account = w3.eth.account.from_key(private_key)
         logger.info(f"Using account: {account.address}")
         return account.address
-    
+
     # If the account cannot be retrieved, log the error and raise an exception
     except Exception as e:
         logger.error(f"Failed to retrieve account from private key: {str(e)}")

src/utils/config_loader.py

@@ -34,6 +34,7 @@
 
 class ConfigurationError(Exception):
     """Raised when configuration loading fails."""
+
     pass
 
 

src/utils/key_validator.py

@@ -14,12 +14,14 @@
 
 class KeyValidationError(Exception):
     """Raised when key validation fails."""
+
     pass
 
 
 @dataclass
 class KeyValidationResult:
     """Result of private key validation."""
+
     is_valid: bool
     formatted_key: Optional[str]
     error_message: Optional[str]